Cisco-IOS-XR-ipv4-dhcpd-cfg API API Reference

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

IPV4-DHCPD - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Update operation of resource: ipv4-dhcpd

ipv4-dhcpdbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "outer-cos": "integer",    "full-write-interval": "integer",
    "incremental-write-interval": "integer",
    "proxy": [ null ],
    "snoop": [ null ],
    "server": [ null ]
  },      {          "profile-name": "string",
          "mode": "string"
        },
        "interface-name": "string",          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },              {
                "client-id": "string",
                "layer": "string",
                "static-address": "string",
                "mac-address": "string"
              }
            ]
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Create operation of resource: ipv4-dhcpd

ipv4-dhcpdbody object

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],
  "outer-cos": "integer",    "full-write-interval": "integer",
    "incremental-write-interval": "integer",
    "proxy": [ null ],
    "snoop": [ null ],
    "server": [ null ]
  },      {          "profile-name": "string",
          "mode": "string"
        },
        "interface-name": "string",          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },              {
                "client-id": "string",
                "layer": "string",
                "static-address": "string",
                "mac-address": "string"
              }
            ]
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string"
          }
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Delete operation of resource: ipv4-dhcpd

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4-DHCPD - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/

Retrieve operation of resource: ipv4-dhcpd

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "enable": [ null ],
  "outer-cos": "integer",    "full-write-interval": "integer",
    "incremental-write-interval": "integer",
    "proxy": [ null ],
    "snoop": [ null ],
    "server": [ null ]
  },      {          "profile-name": "string",
          "mode": "string"
        },
        "interface-name": "string",          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },              {
                "client-id": "string",
                "layer": "string",
                "static-address": "string",
                "mac-address": "string"
              }
            ]
          }
        },          "profile": "string",            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string"
          }
        }
      }
    ]
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Update operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Create operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/

Retrieve operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrfbody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Update operation of resource: profile

profilebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Create operation of resource: profile

profilebody object

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Delete operation of resource: profile

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/vrfs/vrf/{vrf-name}/profile/

Retrieve operation of resource: profile

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile-name": "string",
  "mode": "string"
}

PROFILES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Update operation of resource: profiles

profilesbody object

Request Content-Types: application/json
Request Example
{    {          {              "proxy-allow-move": [ null ],                "limit-lease-count": "string",
                "limit-type": "string"
              },
              "secure-arp": [ null ],                    "num-discover": "integer",
                    "num-block": "integer",
                    "num-request": "integer"
                  }
                }
              },
              "delayed-authen-proxy": [ null ],                "arg1": "string",
                "arg2": "string"
              },                "policy": "string"
              },                "set-server-options": [ null ],
                "client-lease-time": "integer"
              },                  {
                    "enable": [ null ],                        {
                          "vrf-name": "string",                              {
                                "server-address": "string",
                                "gateway-address": "string"
                              }
                            ]
                          }
                        }
                      ]
                    },
                    "class-name": "string",                        "pattern": "string",
                        "bit-mask": "string",
                        "option-type": "string"
                      },
                      "vrf": "string"
                    }
                  }
                ]
              },                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "enable": [ null ],                "policy": "string"
              },                    "option": [ "integer" ],
                    "option-all": "integer"
                  }
                }
              },                    {
                      "pattern": "string",
                      "matchaction": "string",
                      "matchoption": "integer",
                      "format": "integer"
                    }
                  ]
                },                    {
                      "def-matchaction": "string",
                      "def-matchoption": "integer"
                    }
                  ]
                }
              },                "authenticate": "string",
                "option": [ null ],
                "remote-id-xr": [ null ],
                "allow-untrusted": [ null ],
                "remote-id-suppress": [ null ],
                "vpn-mode": "string",
                "remote-id": "string",
                "circuit-id": [ null ],
                "policy": "string",
                "vpn": [ null ],
                "check": [ null ]
              }
            },
            "enable": [ null ],                "policy": "string"
              },                "policy": "string"
              },
              "mac-mismatch-action": "string",                "insert": [ null ]
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Create operation of resource: profiles

profilesbody object

Request Content-Types: application/json
Request Example
{    {          {              "proxy-allow-move": [ null ],                "limit-lease-count": "string",
                "limit-type": "string"
              },
              "secure-arp": [ null ],                    "num-discover": "integer",
                    "num-block": "integer",
                    "num-request": "integer"
                  }
                }
              },
              "delayed-authen-proxy": [ null ],                "arg1": "string",
                "arg2": "string"
              },                "policy": "string"
              },                "set-server-options": [ null ],
                "client-lease-time": "integer"
              },                  {
                    "enable": [ null ],                        {
                          "vrf-name": "string",                              {
                                "server-address": "string",
                                "gateway-address": "string"
                              }
                            ]
                          }
                        }
                      ]
                    },
                    "class-name": "string",                        "pattern": "string",
                        "bit-mask": "string",
                        "option-type": "string"
                      },
                      "vrf": "string"
                    }
                  }
                ]
              },                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "enable": [ null ],                "policy": "string"
              },                    "option": [ "integer" ],
                    "option-all": "integer"
                  }
                }
              },                    {
                      "pattern": "string",
                      "matchaction": "string",
                      "matchoption": "integer",
                      "format": "integer"
                    }
                  ]
                },                    {
                      "def-matchaction": "string",
                      "def-matchoption": "integer"
                    }
                  ]
                }
              },                "authenticate": "string",
                "option": [ null ],
                "remote-id-xr": [ null ],
                "allow-untrusted": [ null ],
                "remote-id-suppress": [ null ],
                "vpn-mode": "string",
                "remote-id": "string",
                "circuit-id": [ null ],
                "policy": "string",
                "vpn": [ null ],
                "check": [ null ]
              }
            },
            "enable": [ null ],                "policy": "string"
              },                "policy": "string"
              },
              "mac-mismatch-action": "string",                "insert": [ null ]
              }
            }
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Delete operation of resource: profiles

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/

Retrieve operation of resource: profiles

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {              "proxy-allow-move": [ null ],                "limit-lease-count": "string",
                "limit-type": "string"
              },
              "secure-arp": [ null ],                    "num-discover": "integer",
                    "num-block": "integer",
                    "num-request": "integer"
                  }
                }
              },
              "delayed-authen-proxy": [ null ],                "arg1": "string",
                "arg2": "string"
              },                "policy": "string"
              },                "set-server-options": [ null ],
                "client-lease-time": "integer"
              },                  {
                    "enable": [ null ],                        {
                          "vrf-name": "string",                              {
                                "server-address": "string",
                                "gateway-address": "string"
                              }
                            ]
                          }
                        }
                      ]
                    },
                    "class-name": "string",                        "pattern": "string",
                        "bit-mask": "string",
                        "option-type": "string"
                      },
                      "vrf": "string"
                    }
                  }
                ]
              },                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "enable": [ null ],                "policy": "string"
              },                    "option": [ "integer" ],
                    "option-all": "integer"
                  }
                }
              },                    {
                      "pattern": "string",
                      "matchaction": "string",
                      "matchoption": "integer",
                      "format": "integer"
                    }
                  ]
                },                    {
                      "def-matchaction": "string",
                      "def-matchoption": "integer"
                    }
                  ]
                }
              },                "authenticate": "string",
                "option": [ null ],
                "remote-id-xr": [ null ],
                "allow-untrusted": [ null ],
                "remote-id-suppress": [ null ],
                "vpn-mode": "string",
                "remote-id": "string",
                "circuit-id": [ null ],
                "policy": "string",
                "vpn": [ null ],
                "check": [ null ]
              }
            },
            "enable": [ null ],                "policy": "string"
              },                "policy": "string"
              },
              "mac-mismatch-action": "string",                "insert": [ null ]
              }
            }
          }
        ]
      }
    }
  ]
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Update operation of resource: profile

profilebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Create operation of resource: profile

profilebody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Delete operation of resource: profile

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/

Retrieve operation of resource: profile

profile-name: string
in path

ID of profile-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile-name": "string",
  "mode": "string"
}

MODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Update operation of resource: modes

modesbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{    {        "proxy-allow-move": [ null ],          "limit-lease-count": "string",
          "limit-type": "string"
        },
        "secure-arp": [ null ],              "num-discover": "integer",
              "num-block": "integer",
              "num-request": "integer"
            }
          }
        },
        "delayed-authen-proxy": [ null ],          "arg1": "string",
          "arg2": "string"
        },          "policy": "string"
        },          "set-server-options": [ null ],
          "client-lease-time": "integer"
        },            {
              "enable": [ null ],                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "class-name": "string",                  "pattern": "string",
                  "bit-mask": "string",
                  "option-type": "string"
                },
                "vrf": "string"
              }
            }
          ]
        },            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "enable": [ null ],          "policy": "string"
        },              "option": [ "integer" ],
              "option-all": "integer"
            }
          }
        },              {
                "pattern": "string",
                "matchaction": "string",
                "matchoption": "integer",
                "format": "integer"
              }
            ]
          },              {
                "def-matchaction": "string",
                "def-matchoption": "integer"
              }
            ]
          }
        },          "authenticate": "string",
          "option": [ null ],
          "remote-id-xr": [ null ],
          "allow-untrusted": [ null ],
          "remote-id-suppress": [ null ],
          "vpn-mode": "string",
          "remote-id": "string",
          "circuit-id": [ null ],
          "policy": "string",
          "vpn": [ null ],
          "check": [ null ]
        }
      },
      "enable": [ null ],          "policy": "string"
        },          "policy": "string"
        },
        "mac-mismatch-action": "string",          "insert": [ null ],
          "subscriber-id": "string",
          "vpn-mode": "string",
          "allow-untrusted": [ null ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Create operation of resource: modes

modesbody object

profile-name: string
in path

ID of profile-name

Request Content-Types: application/json
Request Example
{    {        "proxy-allow-move": [ null ],          "limit-lease-count": "string",
          "limit-type": "string"
        },
        "secure-arp": [ null ],              "num-discover": "integer",
              "num-block": "integer",
              "num-request": "integer"
            }
          }
        },
        "delayed-authen-proxy": [ null ],          "arg1": "string",
          "arg2": "string"
        },          "policy": "string"
        },          "set-server-options": [ null ],
          "client-lease-time": "integer"
        },            {
              "enable": [ null ],                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "class-name": "string",                  "pattern": "string",
                  "bit-mask": "string",
                  "option-type": "string"
                },
                "vrf": "string"
              }
            }
          ]
        },            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "enable": [ null ],          "policy": "string"
        },              "option": [ "integer" ],
              "option-all": "integer"
            }
          }
        },              {
                "pattern": "string",
                "matchaction": "string",
                "matchoption": "integer",
                "format": "integer"
              }
            ]
          },              {
                "def-matchaction": "string",
                "def-matchoption": "integer"
              }
            ]
          }
        },          "authenticate": "string",
          "option": [ null ],
          "remote-id-xr": [ null ],
          "allow-untrusted": [ null ],
          "remote-id-suppress": [ null ],
          "vpn-mode": "string",
          "remote-id": "string",
          "circuit-id": [ null ],
          "policy": "string",
          "vpn": [ null ],
          "check": [ null ]
        }
      },
      "enable": [ null ],          "policy": "string"
        },          "policy": "string"
        },
        "mac-mismatch-action": "string",          "insert": [ null ],
          "subscriber-id": "string",
          "vpn-mode": "string",
          "allow-untrusted": [ null ]
        }
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Delete operation of resource: modes

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/

Retrieve operation of resource: modes

profile-name: string
in path

ID of profile-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {        "proxy-allow-move": [ null ],          "limit-lease-count": "string",
          "limit-type": "string"
        },
        "secure-arp": [ null ],              "num-discover": "integer",
              "num-block": "integer",
              "num-request": "integer"
            }
          }
        },
        "delayed-authen-proxy": [ null ],          "arg1": "string",
          "arg2": "string"
        },          "policy": "string"
        },          "set-server-options": [ null ],
          "client-lease-time": "integer"
        },            {
              "enable": [ null ],                  {
                    "vrf-name": "string",                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "class-name": "string",                  "pattern": "string",
                  "bit-mask": "string",
                  "option-type": "string"
                },
                "vrf": "string"
              }
            }
          ]
        },            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "enable": [ null ],          "policy": "string"
        },              "option": [ "integer" ],
              "option-all": "integer"
            }
          }
        },              {
                "pattern": "string",
                "matchaction": "string",
                "matchoption": "integer",
                "format": "integer"
              }
            ]
          },              {
                "def-matchaction": "string",
                "def-matchoption": "integer"
              }
            ]
          }
        },          "authenticate": "string",
          "option": [ null ],
          "remote-id-xr": [ null ],
          "allow-untrusted": [ null ],
          "remote-id-suppress": [ null ],
          "vpn-mode": "string",
          "remote-id": "string",
          "circuit-id": [ null ],
          "policy": "string",
          "vpn": [ null ],
          "check": [ null ]
        }
      },
      "enable": [ null ],          "policy": "string"
        },          "policy": "string"
        },
        "mac-mismatch-action": "string",          "insert": [ null ],
          "subscriber-id": "string",
          "vpn-mode": "string",
          "allow-untrusted": [ null ]
        }
      }
    }
  ]
}

MODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Update operation of resource: mode

modebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "proxy-allow-move": [ null ],      "limit-lease-count": "string",
      "limit-type": "string"
    },
    "secure-arp": [ null ],          "num-discover": "integer",
          "num-block": "integer",
          "num-request": "integer"
        }
      }
    },
    "delayed-authen-proxy": [ null ],      "arg1": "string",
      "arg2": "string"
    },      "policy": "string"
    },      "set-server-options": [ null ],
      "client-lease-time": "integer"
    },        {
          "enable": [ null ],              {
                "vrf-name": "string",                    {
                      "server-address": "string",
                      "gateway-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "class-name": "string",              "pattern": "string",
              "bit-mask": "string",
              "option-type": "string"
            },
            "vrf": "string"
          }
        }
      ]
    },        {
          "vrf-name": "string",              {
                "server-address": "string",
                "gateway-address": "string"
              }
            ]
          }
        }
      ]
    },
    "enable": [ null ],      "policy": "string"
    },          "option": [ "integer" ],
          "option-all": "integer"
        }
      }
    },          {
            "pattern": "string",
            "matchaction": "string",
            "matchoption": "integer",
            "format": "integer"
          }
        ]
      },          {
            "def-matchaction": "string",
            "def-matchoption": "integer"
          }
        ]
      }
    },      "authenticate": "string",
      "option": [ null ],
      "remote-id-xr": [ null ],
      "allow-untrusted": [ null ],
      "remote-id-suppress": [ null ],
      "vpn-mode": "string",
      "remote-id": "string",
      "circuit-id": [ null ],
      "policy": "string",
      "vpn": [ null ],
      "check": [ null ]
    }
  },
  "enable": [ null ],      "policy": "string"
    },      "policy": "string"
    },
    "mac-mismatch-action": "string",      "insert": [ null ],
      "subscriber-id": "string",
      "vpn-mode": "string",
      "allow-untrusted": [ null ],
      "policy": "string",
      "vpn": [ null ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Create operation of resource: mode

modebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "proxy-allow-move": [ null ],      "limit-lease-count": "string",
      "limit-type": "string"
    },
    "secure-arp": [ null ],          "num-discover": "integer",
          "num-block": "integer",
          "num-request": "integer"
        }
      }
    },
    "delayed-authen-proxy": [ null ],      "arg1": "string",
      "arg2": "string"
    },      "policy": "string"
    },      "set-server-options": [ null ],
      "client-lease-time": "integer"
    },        {
          "enable": [ null ],              {
                "vrf-name": "string",                    {
                      "server-address": "string",
                      "gateway-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "class-name": "string",              "pattern": "string",
              "bit-mask": "string",
              "option-type": "string"
            },
            "vrf": "string"
          }
        }
      ]
    },        {
          "vrf-name": "string",              {
                "server-address": "string",
                "gateway-address": "string"
              }
            ]
          }
        }
      ]
    },
    "enable": [ null ],      "policy": "string"
    },          "option": [ "integer" ],
          "option-all": "integer"
        }
      }
    },          {
            "pattern": "string",
            "matchaction": "string",
            "matchoption": "integer",
            "format": "integer"
          }
        ]
      },          {
            "def-matchaction": "string",
            "def-matchoption": "integer"
          }
        ]
      }
    },      "authenticate": "string",
      "option": [ null ],
      "remote-id-xr": [ null ],
      "allow-untrusted": [ null ],
      "remote-id-suppress": [ null ],
      "vpn-mode": "string",
      "remote-id": "string",
      "circuit-id": [ null ],
      "policy": "string",
      "vpn": [ null ],
      "check": [ null ]
    }
  },
  "enable": [ null ],      "policy": "string"
    },      "policy": "string"
    },
    "mac-mismatch-action": "string",      "insert": [ null ],
      "subscriber-id": "string",
      "vpn-mode": "string",
      "allow-untrusted": [ null ],
      "policy": "string",
      "vpn": [ null ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Delete operation of resource: mode

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/

Retrieve operation of resource: mode

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "proxy-allow-move": [ null ],      "limit-lease-count": "string",
      "limit-type": "string"
    },
    "secure-arp": [ null ],          "num-discover": "integer",
          "num-block": "integer",
          "num-request": "integer"
        }
      }
    },
    "delayed-authen-proxy": [ null ],      "arg1": "string",
      "arg2": "string"
    },      "policy": "string"
    },      "set-server-options": [ null ],
      "client-lease-time": "integer"
    },        {
          "enable": [ null ],              {
                "vrf-name": "string",                    {
                      "server-address": "string",
                      "gateway-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "class-name": "string",              "pattern": "string",
              "bit-mask": "string",
              "option-type": "string"
            },
            "vrf": "string"
          }
        }
      ]
    },        {
          "vrf-name": "string",              {
                "server-address": "string",
                "gateway-address": "string"
              }
            ]
          }
        }
      ]
    },
    "enable": [ null ],      "policy": "string"
    },          "option": [ "integer" ],
          "option-all": "integer"
        }
      }
    },          {
            "pattern": "string",
            "matchaction": "string",
            "matchoption": "integer",
            "format": "integer"
          }
        ]
      },          {
            "def-matchaction": "string",
            "def-matchoption": "integer"
          }
        ]
      }
    },      "authenticate": "string",
      "option": [ null ],
      "remote-id-xr": [ null ],
      "allow-untrusted": [ null ],
      "remote-id-suppress": [ null ],
      "vpn-mode": "string",
      "remote-id": "string",
      "circuit-id": [ null ],
      "policy": "string",
      "vpn": [ null ],
      "check": [ null ]
    }
  },
  "enable": [ null ],      "policy": "string"
    },      "policy": "string"
    },
    "mac-mismatch-action": "string",      "insert": [ null ],
      "subscriber-id": "string",
      "vpn-mode": "string",
      "allow-untrusted": [ null ],
      "policy": "string",
      "vpn": [ null ]
    }
  }
}

SNOOP - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Update operation of resource: snoop

snoopbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string",
    "insert": [ null ],      "format-type": "integer",
      "remote-id-value": "string"
    },
    "allow-untrusted": [ null ]
  },
  "trusted": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Create operation of resource: snoop

snoopbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string",
    "insert": [ null ],      "format-type": "integer",
      "remote-id-value": "string"
    },
    "allow-untrusted": [ null ]
  },
  "trusted": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Delete operation of resource: snoop

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/

Retrieve operation of resource: snoop

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "policy": "string",
    "insert": [ null ],      "format-type": "integer",
      "remote-id-value": "string"
    },
    "allow-untrusted": [ null ]
  },
  "trusted": [ null ]
}

RELAY-INFORMATION-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Update operation of resource: relay-information-option

relay-information-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Create operation of resource: relay-information-option

relay-information-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Delete operation of resource: relay-information-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/

Retrieve operation of resource: relay-information-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}

REMOTE-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Update operation of resource: remote-id

remote-idbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "format-type": "integer",
  "remote-id-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Create operation of resource: remote-id

remote-idbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "format-type": "integer",
  "remote-id-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Delete operation of resource: remote-id

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/snoop/relay-information-option/remote-id/

Retrieve operation of resource: remote-id

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "format-type": "integer",
  "remote-id-value": "string"
}

BASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Update operation of resource: base

basebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "profile-name": "string",
    "profile-mode": "integer"
  },    "authenticate": "integer",
    "remote-id": "string"
  },
  "enable": [ null ],        {
          "pattern": "string",
          "matchoption": "integer",
          "option-action": "string",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },        {
          "opt60": "integer",            "profile-name": "string",
            "profile-mode": "integer"
          },
          "opt60-hex-str": "string",
          "format": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Create operation of resource: base

basebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "profile-name": "string",
    "profile-mode": "integer"
  },    "authenticate": "integer",
    "remote-id": "string"
  },
  "enable": [ null ],        {
          "pattern": "string",
          "matchoption": "integer",
          "option-action": "string",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },        {
          "opt60": "integer",            "profile-name": "string",
            "profile-mode": "integer"
          },
          "opt60-hex-str": "string",
          "format": "integer"
        }
      ]
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Delete operation of resource: base

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/

Retrieve operation of resource: base

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "profile-name": "string",
    "profile-mode": "integer"
  },    "authenticate": "integer",
    "remote-id": "string"
  },
  "enable": [ null ],        {
          "pattern": "string",
          "matchoption": "integer",
          "option-action": "string",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },        {
          "opt60": "integer",            "profile-name": "string",
            "profile-mode": "integer"
          },
          "opt60-hex-str": "string",
          "format": "integer"
        }
      ]
    }
  }
}

DEFAULT-PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Update operation of resource: default-profile

default-profilebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Create operation of resource: default-profile

default-profilebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Delete operation of resource: default-profile

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/default-profile/

Retrieve operation of resource: default-profile

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile-name": "string",
  "profile-mode": "integer"
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Update operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Create operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Delete operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/

Retrieve operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}

OPTION-FILTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Update operation of resource: option-filters

option-filtersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Create operation of resource: option-filters

option-filtersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Delete operation of resource: option-filters

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/

Retrieve operation of resource: option-filters

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}

OPTION-FILTER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Update operation of resource: option-filter

option-filterbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Create operation of resource: option-filter

option-filterbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Delete operation of resource: option-filter

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/option-filters/option-filter/{matchoption pattern format}/

Retrieve operation of resource: option-filter

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}

DEF-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Update operation of resource: def-options

def-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Create operation of resource: def-options

def-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Delete operation of resource: def-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/

Retrieve operation of resource: def-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}

DEF-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Update operation of resource: def-option

def-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Request Content-Types: application/json
Request Example
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Create operation of resource: def-option

def-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Request Content-Types: application/json
Request Example
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Delete operation of resource: def-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/match/def-options/def-option/{def-matchoption}/

Retrieve operation of resource: def-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}

BASE-RELAY-OPT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Update operation of resource: base-relay-opt

base-relay-optbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "authenticate": "integer",
  "remote-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Create operation of resource: base-relay-opt

base-relay-optbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "authenticate": "integer",
  "remote-id": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Delete operation of resource: base-relay-opt

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-RELAY-OPT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-relay-opt/

Retrieve operation of resource: base-relay-opt

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "authenticate": "integer",
  "remote-id": "string"
}

BASE-MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Update operation of resource: base-match

base-matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "opt60": "integer",          "profile-name": "string",
          "profile-mode": "integer"
        },
        "opt60-hex-str": "string",
        "format": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Create operation of resource: base-match

base-matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "opt60": "integer",          "profile-name": "string",
          "profile-mode": "integer"
        },
        "opt60-hex-str": "string",
        "format": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Delete operation of resource: base-match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/

Retrieve operation of resource: base-match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "opt60": "integer",          "profile-name": "string",
          "profile-mode": "integer"
        },
        "opt60-hex-str": "string",
        "format": "integer"
      }
    ]
  }
}

OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Update operation of resource: options

optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Create operation of resource: options

optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Delete operation of resource: options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/

Retrieve operation of resource: options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Update operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Create operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Delete operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/

Retrieve operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}

OPTION-PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Update operation of resource: option-profile

option-profilebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Create operation of resource: option-profile

option-profilebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Delete operation of resource: option-profile

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/base/base-match/options/option/{opt60 opt60-hex-str format}/option-profile/

Retrieve operation of resource: option-profile

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

opt60 opt60-hex-str format: string
in path

ID of opt60 opt60-hex-str format

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile-name": "string",
  "profile-mode": "integer"
}

SERVER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Update operation of resource: server

serverbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "subnet-mask": "string",        "option-number": "integer",
        "option-all": "integer"
      }
    }
  },
  "domain-name": "string",
  "boot-filename": "string",
  "next-server": "string",    "dns-server": [ "string" ]
  },    "check": [ null ]
  },        {
          "matchaction": "string",
          "matchoption": "string"
        }
      ]
    },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "string",
          "format": "integer"
        }
      ]
    }
  },    "infinite": "string",
    "hours": "integer",
    "minutes": "integer",
    "days": "integer"
  },
  "server-allow-move": [ null ],    "range": "integer",
    "lease-limit-value": "string"
  },
  "secure-arp": [ null ],    "authenticate": "integer"
  },
  "enable": [ null ],    "policy": "string"
  },    "net-bios-name-server": [ "string" ]
  },
  "pool": "string",        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },    "default-router": [ "string" ]
  },    "hybrid-node": "string",
    "mixed-node": "string",
    "hexadecimal": "string",
    "broadcast-node": "string",
    "peer-to-peer-node": "string"
  },      "force-insert": [ null ]
    }
  },    "check": [ null ]
  },      {          "default-router": [ "string" ]
        },          "l2-interface": "string"
        },            {
              "option-code": "integer",
              "hex-string": "string",
              "ascii-string": "string",
              "ip-address": [ "string" ],
              "force-insert": "integer"
            }
          ]
        }
      }
    ]
  },      {
        "option-code": "integer",
        "hex-string": "string",
        "ascii-string": "string",
        "ip-address": [ "string" ],
        "force-insert": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Create operation of resource: server

serverbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "subnet-mask": "string",        "option-number": "integer",
        "option-all": "integer"
      }
    }
  },
  "domain-name": "string",
  "boot-filename": "string",
  "next-server": "string",    "dns-server": [ "string" ]
  },    "check": [ null ]
  },        {
          "matchaction": "string",
          "matchoption": "string"
        }
      ]
    },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "string",
          "format": "integer"
        }
      ]
    }
  },    "infinite": "string",
    "hours": "integer",
    "minutes": "integer",
    "days": "integer"
  },
  "server-allow-move": [ null ],    "range": "integer",
    "lease-limit-value": "string"
  },
  "secure-arp": [ null ],    "authenticate": "integer"
  },
  "enable": [ null ],    "policy": "string"
  },    "net-bios-name-server": [ "string" ]
  },
  "pool": "string",        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },    "default-router": [ "string" ]
  },    "hybrid-node": "string",
    "mixed-node": "string",
    "hexadecimal": "string",
    "broadcast-node": "string",
    "peer-to-peer-node": "string"
  },      "force-insert": [ null ]
    }
  },    "check": [ null ]
  },      {          "default-router": [ "string" ]
        },          "l2-interface": "string"
        },            {
              "option-code": "integer",
              "hex-string": "string",
              "ascii-string": "string",
              "ip-address": [ "string" ],
              "force-insert": "integer"
            }
          ]
        }
      }
    ]
  },      {
        "option-code": "integer",
        "hex-string": "string",
        "ascii-string": "string",
        "ip-address": [ "string" ],
        "force-insert": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Delete operation of resource: server

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/

Retrieve operation of resource: server

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "subnet-mask": "string",        "option-number": "integer",
        "option-all": "integer"
      }
    }
  },
  "domain-name": "string",
  "boot-filename": "string",
  "next-server": "string",    "dns-server": [ "string" ]
  },    "check": [ null ]
  },        {
          "matchaction": "string",
          "matchoption": "string"
        }
      ]
    },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "string",
          "format": "integer"
        }
      ]
    }
  },    "infinite": "string",
    "hours": "integer",
    "minutes": "integer",
    "days": "integer"
  },
  "server-allow-move": [ null ],    "range": "integer",
    "lease-limit-value": "string"
  },
  "secure-arp": [ null ],    "authenticate": "integer"
  },
  "enable": [ null ],    "policy": "string"
  },    "net-bios-name-server": [ "string" ]
  },
  "pool": "string",        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },    "default-router": [ "string" ]
  },    "hybrid-node": "string",
    "mixed-node": "string",
    "hexadecimal": "string",
    "broadcast-node": "string",
    "peer-to-peer-node": "string"
  },      "force-insert": [ null ]
    }
  },    "check": [ null ]
  },      {          "default-router": [ "string" ]
        },          "l2-interface": "string"
        },            {
              "option-code": "integer",
              "hex-string": "string",
              "ascii-string": "string",
              "ip-address": [ "string" ],
              "force-insert": "integer"
            }
          ]
        }
      }
    ]
  },      {
        "option-code": "integer",
        "hex-string": "string",
        "ascii-string": "string",
        "ip-address": [ "string" ],
        "force-insert": "integer"
      }
    ]
  }
}

SERVER-ID-CHECK - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Update operation of resource: server-id-check

server-id-checkbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Create operation of resource: server-id-check

server-id-checkbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Delete operation of resource: server-id-check

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-ID-CHECK - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/server-id-check/

Retrieve operation of resource: server-id-check

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "check": [ null ]
}

LEASE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Update operation of resource: lease-limit

lease-limitbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "range": "integer",
  "lease-limit-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Create operation of resource: lease-limit

lease-limitbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "range": "integer",
  "lease-limit-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Delete operation of resource: lease-limit

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease-limit/

Retrieve operation of resource: lease-limit

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "range": "integer",
  "lease-limit-value": "string"
}

REQUESTED-IP-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Update operation of resource: requested-ip-address

requested-ip-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Create operation of resource: requested-ip-address

requested-ip-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Delete operation of resource: requested-ip-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REQUESTED-IP-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/requested-ip-address/

Retrieve operation of resource: requested-ip-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "check": [ null ]
}

AAA-SERVER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Update operation of resource: aaa-server

aaa-serverbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "force-insert": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Create operation of resource: aaa-server

aaa-serverbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "force-insert": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Delete operation of resource: aaa-server

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AAA-SERVER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/

Retrieve operation of resource: aaa-server

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "force-insert": [ null ]
  }
}

DHCP-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Update operation of resource: dhcp-option

dhcp-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "force-insert": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Create operation of resource: dhcp-option

dhcp-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "force-insert": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Delete operation of resource: dhcp-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/aaa-server/dhcp-option/

Retrieve operation of resource: dhcp-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "force-insert": [ null ]
}

DEFAULT-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Update operation of resource: default-routers

default-routersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "default-router": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Create operation of resource: default-routers

default-routersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "default-router": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Delete operation of resource: default-routers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/default-routers/

Retrieve operation of resource: default-routers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "default-router": [ "string" ]
}

NET-BIOS-NAME-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Update operation of resource: net-bios-name-servers

net-bios-name-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "net-bios-name-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Create operation of resource: net-bios-name-servers

net-bios-name-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "net-bios-name-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Delete operation of resource: net-bios-name-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/net-bios-name-servers/

Retrieve operation of resource: net-bios-name-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "net-bios-name-server": [ "string" ]
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Update operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Create operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Delete operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/

Retrieve operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}

OPTION-DEFAULTS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Update operation of resource: option-defaults

option-defaultsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "matchaction": "string",
      "matchoption": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Create operation of resource: option-defaults

option-defaultsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "matchaction": "string",
      "matchoption": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Delete operation of resource: option-defaults

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULTS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/

Retrieve operation of resource: option-defaults

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "matchaction": "string",
      "matchoption": "string"
    }
  ]
}

OPTION-DEFAULT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Update operation of resource: option-default

option-defaultbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption: string
in path

ID of matchoption

Request Content-Types: application/json
Request Example
{
  "matchaction": "string",
  "matchoption": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Create operation of resource: option-default

option-defaultbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption: string
in path

ID of matchoption

Request Content-Types: application/json
Request Example
{
  "matchaction": "string",
  "matchoption": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Delete operation of resource: option-default

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption: string
in path

ID of matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-DEFAULT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/option-defaults/option-default/{matchoption}/

Retrieve operation of resource: option-default

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption: string
in path

ID of matchoption

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "matchaction": "string",
  "matchoption": "string"
}

OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Update operation of resource: options

optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Create operation of resource: options

optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Delete operation of resource: options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/

Retrieve operation of resource: options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Update operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Create operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Delete operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/match/options/option/{matchoption pattern format}/

Retrieve operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}

BROADCAST-FLAG - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Update operation of resource: broadcast-flag

broadcast-flagbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Create operation of resource: broadcast-flag

broadcast-flagbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Delete operation of resource: broadcast-flag

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/broadcast-flag/

Retrieve operation of resource: broadcast-flag

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "policy": "string"
}

SESSION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Update operation of resource: session

sessionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Create operation of resource: session

sessionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Delete operation of resource: session

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/

Retrieve operation of resource: session

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}

THROTTLE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Update operation of resource: throttle-type

throttle-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Create operation of resource: throttle-type

throttle-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Delete operation of resource: throttle-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THROTTLE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/

Retrieve operation of resource: throttle-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}

MAC-THROTTLE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Update operation of resource: mac-throttle

mac-throttlebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Create operation of resource: mac-throttle

mac-throttlebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Delete operation of resource: mac-throttle

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MAC-THROTTLE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/session/throttle-type/mac-throttle/

Retrieve operation of resource: mac-throttle

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}

CLASSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Update operation of resource: classes

classesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Create operation of resource: classes

classesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Delete operation of resource: classes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/

Retrieve operation of resource: classes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}

CLASS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Update operation of resource: class

classbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Create operation of resource: class

classbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Delete operation of resource: class

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/

Retrieve operation of resource: class

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}

DEFAULT-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Update operation of resource: default-routers

default-routersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "default-router": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Create operation of resource: default-routers

default-routersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "default-router": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Delete operation of resource: default-routers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/default-routers/

Retrieve operation of resource: default-routers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "default-router": [ "string" ]
}

NET-BIOS-NAME-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Update operation of resource: net-bios-name-servers

net-bios-name-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "net-bios-name-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Create operation of resource: net-bios-name-servers

net-bios-name-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "net-bios-name-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Delete operation of resource: net-bios-name-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NET-BIOS-NAME-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/net-bios-name-servers/

Retrieve operation of resource: net-bios-name-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "net-bios-name-server": [ "string" ]
}

CLASS-MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Update operation of resource: class-match

class-matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "l2-interface": "string",      {
        "pattern": "string",
        "matchoption": "string",
        "bit-mask": "string"
      }
    ]
  },
  "vrf": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Create operation of resource: class-match

class-matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "l2-interface": "string",      {
        "pattern": "string",
        "matchoption": "string",
        "bit-mask": "string"
      }
    ]
  },
  "vrf": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Delete operation of resource: class-match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/

Retrieve operation of resource: class-match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "l2-interface": "string",      {
        "pattern": "string",
        "matchoption": "string",
        "bit-mask": "string"
      }
    ]
  },
  "vrf": "string"
}

CLASS-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Update operation of resource: class-options

class-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchoption": "string",
      "bit-mask": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Create operation of resource: class-options

class-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchoption": "string",
      "bit-mask": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Delete operation of resource: class-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/

Retrieve operation of resource: class-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "pattern": "string",
      "matchoption": "string",
      "bit-mask": "string"
    }
  ]
}

CLASS-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Update operation of resource: class-option

class-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

matchoption: string
in path

ID of matchoption

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchoption": "string",
  "bit-mask": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Create operation of resource: class-option

class-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

matchoption: string
in path

ID of matchoption

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchoption": "string",
  "bit-mask": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Delete operation of resource: class-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

matchoption: string
in path

ID of matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/class-match/class-options/class-option/{matchoption}/

Retrieve operation of resource: class-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

matchoption: string
in path

ID of matchoption

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "pattern": "string",
  "matchoption": "string",
  "bit-mask": "string"
}

LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Update operation of resource: lease

leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Create operation of resource: lease

leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Delete operation of resource: lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/lease/

Retrieve operation of resource: lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}

NETBIOS-NODE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Update operation of resource: netbios-node-type

netbios-node-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Create operation of resource: netbios-node-type

netbios-node-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Delete operation of resource: netbios-node-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/netbios-node-type/

Retrieve operation of resource: netbios-node-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}

DNS-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Update operation of resource: dns-servers

dns-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "dns-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Create operation of resource: dns-servers

dns-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "dns-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Delete operation of resource: dns-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/dns-servers/

Retrieve operation of resource: dns-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "dns-server": [ "string" ]
}

OPTION-CODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Update operation of resource: option-codes

option-codesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Create operation of resource: option-codes

option-codesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Delete operation of resource: option-codes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/

Retrieve operation of resource: option-codes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}

OPTION-CODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Update operation of resource: option-code

option-codebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

option-code: string
in path

ID of option-code

Request Content-Types: application/json
Request Example
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Create operation of resource: option-code

option-codebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

option-code: string
in path

ID of option-code

Request Content-Types: application/json
Request Example
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Delete operation of resource: option-code

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

option-code: string
in path

ID of option-code

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/classes/class/{class-name}/option-codes/option-code/{option-code}/

Retrieve operation of resource: option-code

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

option-code: string
in path

ID of option-code

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}

RELAY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Update operation of resource: relay

relaybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Create operation of resource: relay

relaybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Delete operation of resource: relay

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/relay/

Retrieve operation of resource: relay

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}

LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Update operation of resource: lease

leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Create operation of resource: lease

leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Delete operation of resource: lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/lease/

Retrieve operation of resource: lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}

NETBIOS-NODE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Update operation of resource: netbios-node-type

netbios-node-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Create operation of resource: netbios-node-type

netbios-node-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Delete operation of resource: netbios-node-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NETBIOS-NODE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/netbios-node-type/

Retrieve operation of resource: netbios-node-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}

DNS-SERVERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Update operation of resource: dns-servers

dns-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "dns-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Create operation of resource: dns-servers

dns-serversbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "dns-server": [ "string" ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Delete operation of resource: dns-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DNS-SERVERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dns-servers/

Retrieve operation of resource: dns-servers

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "dns-server": [ "string" ]
}

DHCP-TO-AAA - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Update operation of resource: dhcp-to-aaa

dhcp-to-aaabody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Create operation of resource: dhcp-to-aaa

dhcp-to-aaabody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Delete operation of resource: dhcp-to-aaa

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/

Retrieve operation of resource: dhcp-to-aaa

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Update operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Create operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Delete operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/

Retrieve operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}

LIST - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Update operation of resource: list

listbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "option": [ "integer" ],
  "option-all": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Create operation of resource: list

listbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "option": [ "integer" ],
  "option-all": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Delete operation of resource: list

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/dhcp-to-aaa/option/list/

Retrieve operation of resource: list

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "option": [ "integer" ],
  "option-all": "integer"
}

OPTION-CODES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Update operation of resource: option-codes

option-codesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Create operation of resource: option-codes

option-codesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Delete operation of resource: option-codes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/

Retrieve operation of resource: option-codes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}

OPTION-CODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Update operation of resource: option-code

option-codebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

option-code: string
in path

ID of option-code

Request Content-Types: application/json
Request Example
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Create operation of resource: option-code

option-codebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

option-code: string
in path

ID of option-code

Request Content-Types: application/json
Request Example
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Delete operation of resource: option-code

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

option-code: string
in path

ID of option-code

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-CODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/server/option-codes/option-code/{option-code}/

Retrieve operation of resource: option-code

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

option-code: string
in path

ID of option-code

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}

RELAY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Update operation of resource: relay

relaybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Create operation of resource: relay

relaybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Delete operation of resource: relay

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/

Retrieve operation of resource: relay

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "policy": "string"
  },    "policy": "string"
  },
  "mac-mismatch-action": "string",    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },      {
        "vrf-name": "string",            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}

GI-ADDR-POLICY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Update operation of resource: gi-addr-policy

gi-addr-policybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Create operation of resource: gi-addr-policy

gi-addr-policybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Delete operation of resource: gi-addr-policy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GI-ADDR-POLICY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/gi-addr-policy/

Retrieve operation of resource: gi-addr-policy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "policy": "string"
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Update operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Create operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Delete operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/

Retrieve operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Update operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Create operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Delete operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{ip-address}/

Retrieve operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "server-address": "string",
  "gateway-address": "string"
}

RELAY-INFORMATION-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Update operation of resource: relay-information-option

relay-information-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Create operation of resource: relay-information-option

relay-information-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Delete operation of resource: relay-information-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/relay-information-option/

Retrieve operation of resource: relay-information-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}

BROADCAST-POLICY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Update operation of resource: broadcast-policy

broadcast-policybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Create operation of resource: broadcast-policy

broadcast-policybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Delete operation of resource: broadcast-policy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-POLICY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/relay/broadcast-policy/

Retrieve operation of resource: broadcast-policy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "policy": "string"
}

PROXY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Update operation of resource: proxy

proxybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "proxy-allow-move": [ null ],    "limit-lease-count": "string",
    "limit-type": "string"
  },
  "secure-arp": [ null ],        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },
  "delayed-authen-proxy": [ null ],    "arg1": "string",
    "arg2": "string"
  },    "policy": "string"
  },    "set-server-options": [ null ],
    "client-lease-time": "integer"
  },      {
        "enable": [ null ],            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "class-name": "string",            "pattern": "string",
            "bit-mask": "string",
            "option-type": "string"
          },
          "vrf": "string"
        }
      }
    ]
  },      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],    "policy": "string"
  },        "option": [ "integer" ],
        "option-all": "integer"
      }
    }
  },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "integer",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },    "authenticate": "string",
    "option": [ null ],
    "remote-id-xr": [ null ],
    "allow-untrusted": [ null ],
    "remote-id-suppress": [ null ],
    "vpn-mode": "string",
    "remote-id": "string",
    "circuit-id": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Create operation of resource: proxy

proxybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "proxy-allow-move": [ null ],    "limit-lease-count": "string",
    "limit-type": "string"
  },
  "secure-arp": [ null ],        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },
  "delayed-authen-proxy": [ null ],    "arg1": "string",
    "arg2": "string"
  },    "policy": "string"
  },    "set-server-options": [ null ],
    "client-lease-time": "integer"
  },      {
        "enable": [ null ],            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "class-name": "string",            "pattern": "string",
            "bit-mask": "string",
            "option-type": "string"
          },
          "vrf": "string"
        }
      }
    ]
  },      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],    "policy": "string"
  },        "option": [ "integer" ],
        "option-all": "integer"
      }
    }
  },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "integer",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },    "authenticate": "string",
    "option": [ null ],
    "remote-id-xr": [ null ],
    "allow-untrusted": [ null ],
    "remote-id-suppress": [ null ],
    "vpn-mode": "string",
    "remote-id": "string",
    "circuit-id": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Delete operation of resource: proxy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/

Retrieve operation of resource: proxy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "proxy-allow-move": [ null ],    "limit-lease-count": "string",
    "limit-type": "string"
  },
  "secure-arp": [ null ],        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },
  "delayed-authen-proxy": [ null ],    "arg1": "string",
    "arg2": "string"
  },    "policy": "string"
  },    "set-server-options": [ null ],
    "client-lease-time": "integer"
  },      {
        "enable": [ null ],            {
              "vrf-name": "string",                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "class-name": "string",            "pattern": "string",
            "bit-mask": "string",
            "option-type": "string"
          },
          "vrf": "string"
        }
      }
    ]
  },      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],    "policy": "string"
  },        "option": [ "integer" ],
        "option-all": "integer"
      }
    }
  },        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "integer",
          "format": "integer"
        }
      ]
    },        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },    "authenticate": "string",
    "option": [ null ],
    "remote-id-xr": [ null ],
    "allow-untrusted": [ null ],
    "remote-id-suppress": [ null ],
    "vpn-mode": "string",
    "remote-id": "string",
    "circuit-id": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  }
}

GIADDR - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Update operation of resource: giaddr

giaddrbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Create operation of resource: giaddr

giaddrbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Delete operation of resource: giaddr

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GIADDR - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/giaddr/

Retrieve operation of resource: giaddr

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "policy": "string"
}

CLASSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Update operation of resource: classes

classesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Create operation of resource: classes

classesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Delete operation of resource: classes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/

Retrieve operation of resource: classes

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "enable": [ null ],          {
            "vrf-name": "string",                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}

CLASS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Update operation of resource: class

classbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Create operation of resource: class

classbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Delete operation of resource: class

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CLASS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/

Retrieve operation of resource: class

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "enable": [ null ],      {
        "vrf-name": "string",            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Update operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Create operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Delete operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/

Retrieve operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Update operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Create operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Delete operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/match/option/

Retrieve operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Update operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Create operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Delete operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/

Retrieve operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Update operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Create operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Delete operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/classes/class/{class-name}/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Retrieve operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

class-name: string
in path

ID of class-name

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "server-address": "string",
  "gateway-address": "string"
}

AUTH-USERNAME - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Update operation of resource: auth-username

auth-usernamebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "arg1": "string",
  "arg2": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Create operation of resource: auth-username

auth-usernamebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "arg1": "string",
  "arg2": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Delete operation of resource: auth-username

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AUTH-USERNAME - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/auth-username/

Retrieve operation of resource: auth-username

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "arg1": "string",
  "arg2": "string"
}

RELAY-INFORMATION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Update operation of resource: relay-information

relay-informationbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "authenticate": "string",
  "option": [ null ],
  "remote-id-xr": [ null ],
  "allow-untrusted": [ null ],
  "remote-id-suppress": [ null ],
  "vpn-mode": "string",
  "remote-id": "string",
  "circuit-id": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Create operation of resource: relay-information

relay-informationbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "authenticate": "string",
  "option": [ null ],
  "remote-id-xr": [ null ],
  "allow-untrusted": [ null ],
  "remote-id-suppress": [ null ],
  "vpn-mode": "string",
  "remote-id": "string",
  "circuit-id": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Delete operation of resource: relay-information

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INFORMATION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/relay-information/

Retrieve operation of resource: relay-information

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "authenticate": "string",
  "option": [ null ],
  "remote-id-xr": [ null ],
  "allow-untrusted": [ null ],
  "remote-id-suppress": [ null ],
  "vpn-mode": "string",
  "remote-id": "string",
  "circuit-id": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}

DHCP-TO-AAA - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Update operation of resource: dhcp-to-aaa

dhcp-to-aaabody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Create operation of resource: dhcp-to-aaa

dhcp-to-aaabody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Delete operation of resource: dhcp-to-aaa

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-TO-AAA - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/

Retrieve operation of resource: dhcp-to-aaa

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}

OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Update operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Create operation of resource: option

optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Delete operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/

Retrieve operation of resource: option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "option": [ "integer" ],
    "option-all": "integer"
  }
}

LIST - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Update operation of resource: list

listbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "option": [ "integer" ],
  "option-all": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Create operation of resource: list

listbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "option": [ "integer" ],
  "option-all": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Delete operation of resource: list

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIST - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/dhcp-to-aaa/option/list/

Retrieve operation of resource: list

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "option": [ "integer" ],
  "option-all": "integer"
}

VRFS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Update operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Create operation of resource: vrfs

vrfsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Delete operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/

Retrieve operation of resource: vrfs

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "vrf-name": "string",          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}

VRF - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrfbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "vrf-name": "string",      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}

HELPER-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Update operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Create operation of resource: helper-addresses

helper-addressesbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Delete operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/

Retrieve operation of resource: helper-addresses

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}

HELPER-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Update operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Create operation of resource: helper-address

helper-addressbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Request Content-Types: application/json
Request Example
{
  "server-address": "string",
  "gateway-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Delete operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HELPER-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/vrfs/vrf/{vrf-name}/helper-addresses/helper-address/{server-address}/

Retrieve operation of resource: helper-address

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

vrf-name: string
in path

ID of vrf-name

server-address: string
in path

ID of server-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "server-address": "string",
  "gateway-address": "string"
}

SESSIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Update operation of resource: sessions

sessionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Create operation of resource: sessions

sessionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Delete operation of resource: sessions

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SESSIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/

Retrieve operation of resource: sessions

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}

PROXY-THROTTLE-TYPE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Update operation of resource: proxy-throttle-type

proxy-throttle-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Create operation of resource: proxy-throttle-type

proxy-throttle-typebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Delete operation of resource: proxy-throttle-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-THROTTLE-TYPE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/

Retrieve operation of resource: proxy-throttle-type

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}

PROXY-MAC-THROTTLE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Update operation of resource: proxy-mac-throttle

proxy-mac-throttlebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Create operation of resource: proxy-mac-throttle

proxy-mac-throttlebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Delete operation of resource: proxy-mac-throttle

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-MAC-THROTTLE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/sessions/proxy-throttle-type/proxy-mac-throttle/

Retrieve operation of resource: proxy-mac-throttle

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}

LIMIT-LEASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Update operation of resource: limit-lease

limit-leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "limit-lease-count": "string",
  "limit-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Create operation of resource: limit-lease

limit-leasebody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "limit-lease-count": "string",
  "limit-type": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Delete operation of resource: limit-lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LIMIT-LEASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/limit-lease/

Retrieve operation of resource: limit-lease

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "limit-lease-count": "string",
  "limit-type": "string"
}

LEASE-PROXY - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Update operation of resource: lease-proxy

lease-proxybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "set-server-options": [ null ],
  "client-lease-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Create operation of resource: lease-proxy

lease-proxybody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "set-server-options": [ null ],
  "client-lease-time": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Delete operation of resource: lease-proxy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LEASE-PROXY - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/lease-proxy/

Retrieve operation of resource: lease-proxy

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "set-server-options": [ null ],
  "client-lease-time": "integer"
}

BROADCAST-FLAG - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Update operation of resource: broadcast-flag

broadcast-flagbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Create operation of resource: broadcast-flag

broadcast-flagbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{
  "policy": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Delete operation of resource: broadcast-flag

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BROADCAST-FLAG - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/broadcast-flag/

Retrieve operation of resource: broadcast-flag

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "policy": "string"
}

MATCH - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Update operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Create operation of resource: match

matchbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Delete operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/

Retrieve operation of resource: match

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}

DEF-OPTIONS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Update operation of resource: def-options

def-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Create operation of resource: def-options

def-optionsbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Delete operation of resource: def-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTIONS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/

Retrieve operation of resource: def-options

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}

DEF-OPTION - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Update operation of resource: def-option

def-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Request Content-Types: application/json
Request Example
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Create operation of resource: def-option

def-optionbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Request Content-Types: application/json
Request Example
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Delete operation of resource: def-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEF-OPTION - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/def-options/def-option/{def-matchoption}/

Retrieve operation of resource: def-option

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

def-matchoption: string
in path

ID of def-matchoption

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}

OPTION-FILTERS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Update operation of resource: option-filters

option-filtersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Create operation of resource: option-filters

option-filtersbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Request Content-Types: application/json
Request Example
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Delete operation of resource: option-filters

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTERS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/

Retrieve operation of resource: option-filters

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}

OPTION-FILTER - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Update operation of resource: option-filter

option-filterbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Create operation of resource: option-filter

option-filterbody object

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Request Content-Types: application/json
Request Example
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Delete operation of resource: option-filter

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTION-FILTER - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/profiles/profile/{profile-name}/modes/mode/{mode}/proxy/match/option-filters/option-filter/{matchoption pattern format}/

Retrieve operation of resource: option-filter

profile-name: string
in path

ID of profile-name

mode: string
in path

ID of mode

matchoption pattern format: string
in path

ID of matchoption pattern format

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}

DATABASE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Update operation of resource: database

databasebody object

Request Content-Types: application/json
Request Example
{
  "full-write-interval": "integer",
  "incremental-write-interval": "integer",
  "proxy": [ null ],
  "snoop": [ null ],
  "server": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Create operation of resource: database

databasebody object

Request Content-Types: application/json
Request Example
{
  "full-write-interval": "integer",
  "incremental-write-interval": "integer",
  "proxy": [ null ],
  "snoop": [ null ],
  "server": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Delete operation of resource: database

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DATABASE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/database/

Retrieve operation of resource: database

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "full-write-interval": "integer",
  "incremental-write-interval": "integer",
  "proxy": [ null ],
  "snoop": [ null ],
  "server": [ null ]
}

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Update operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{    {        "profile-name": "string",
        "mode": "string"
      },
      "interface-name": "string",        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },            {
              "client-id": "string",
              "layer": "string",
              "static-address": "string",
              "mac-address": "string"
            }
          ]
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Create operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{    {        "profile-name": "string",
        "mode": "string"
      },
      "interface-name": "string",        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },            {
              "client-id": "string",
              "layer": "string",
              "static-address": "string",
              "mac-address": "string"
            }
          ]
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/

Retrieve operation of resource: interfaces

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {        "profile-name": "string",
        "mode": "string"
      },
      "interface-name": "string",        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },            {
              "client-id": "string",
              "layer": "string",
              "static-address": "string",
              "mac-address": "string"
            }
          ]
        }
      },        "profile": "string",          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },    }
  ]
}

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Update operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "profile-name": "string",
    "mode": "string"
  },
  "interface-name": "string",    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },        {
          "client-id": "string",
          "layer": "string",
          "static-address": "string",
          "mac-address": "string"
        }
      ]
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "format-type": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Create operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "profile-name": "string",
    "mode": "string"
  },
  "interface-name": "string",    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },        {
          "client-id": "string",
          "layer": "string",
          "static-address": "string",
          "mac-address": "string"
        }
      ]
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "format-type": "integer"
    }
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "profile-name": "string",
    "mode": "string"
  },
  "interface-name": "string",    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },        {
          "client-id": "string",
          "layer": "string",
          "static-address": "string",
          "mac-address": "string"
        }
      ]
    }
  },    "profile": "string",      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },      "format-type": "integer"
    }
  }
}

PROXY-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Update operation of resource: proxy-interface

proxy-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Create operation of resource: proxy-interface

proxy-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Delete operation of resource: proxy-interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROXY-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/

Retrieve operation of resource: proxy-interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Update operation of resource: dhcp-circuit-id

dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Create operation of resource: dhcp-circuit-id

dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Delete operation of resource: dhcp-circuit-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/proxy-interface/dhcp-circuit-id/

Retrieve operation of resource: dhcp-circuit-id

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

BASE-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Update operation of resource: base-interface

base-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Create operation of resource: base-interface

base-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Delete operation of resource: base-interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/

Retrieve operation of resource: base-interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

BASE-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Update operation of resource: base-dhcp-circuit-id

base-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Create operation of resource: base-dhcp-circuit-id

base-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Delete operation of resource: base-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BASE-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/base-interface/base-dhcp-circuit-id/

Retrieve operation of resource: base-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

RELAY-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Update operation of resource: relay-interface

relay-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Create operation of resource: relay-interface

relay-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Delete operation of resource: relay-interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/

Retrieve operation of resource: relay-interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

RELAY-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Update operation of resource: relay-dhcp-circuit-id

relay-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Create operation of resource: relay-dhcp-circuit-id

relay-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Delete operation of resource: relay-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RELAY-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/relay-interface/relay-dhcp-circuit-id/

Retrieve operation of resource: relay-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

STATIC-MODE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Update operation of resource: static-mode

static-modebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "client-id": "string",
        "layer": "string",
        "static-address": "string",
        "mac-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Create operation of resource: static-mode

static-modebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        "client-id": "string",
        "layer": "string",
        "static-address": "string",
        "mac-address": "string"
      }
    ]
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Delete operation of resource: static-mode

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/

Retrieve operation of resource: static-mode

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        "client-id": "string",
        "layer": "string",
        "static-address": "string",
        "mac-address": "string"
      }
    ]
  }
}

STATICS - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Update operation of resource: statics

staticsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "client-id": "string",
      "layer": "string",
      "static-address": "string",
      "mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Create operation of resource: statics

staticsbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      "client-id": "string",
      "layer": "string",
      "static-address": "string",
      "mac-address": "string"
    }
  ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Delete operation of resource: statics

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATICS - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/

Retrieve operation of resource: statics

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      "client-id": "string",
      "layer": "string",
      "static-address": "string",
      "mac-address": "string"
    }
  ]
}

STATIC - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Update operation of resource: static

staticbody object

interface-name: string
in path

ID of interface-name

mac-address client-id layer: string
in path

ID of mac-address client-id layer

Request Content-Types: application/json
Request Example
{
  "client-id": "string",
  "layer": "string",
  "static-address": "string",
  "mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Create operation of resource: static

staticbody object

interface-name: string
in path

ID of interface-name

mac-address client-id layer: string
in path

ID of mac-address client-id layer

Request Content-Types: application/json
Request Example
{
  "client-id": "string",
  "layer": "string",
  "static-address": "string",
  "mac-address": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Delete operation of resource: static

interface-name: string
in path

ID of interface-name

mac-address client-id layer: string
in path

ID of mac-address client-id layer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/static-mode/statics/static/{mac-address client-id layer}/

Retrieve operation of resource: static

interface-name: string
in path

ID of interface-name

mac-address client-id layer: string
in path

ID of mac-address client-id layer

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "client-id": "string",
  "layer": "string",
  "static-address": "string",
  "mac-address": "string"
}

PROFILE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Update operation of resource: profile

profilebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Create operation of resource: profile

profilebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile-name": "string",
  "mode": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Delete operation of resource: profile

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

PROFILE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/profile/

Retrieve operation of resource: profile

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile-name": "string",
  "mode": "string"
}

SERVER-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Update operation of resource: server-interface

server-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Create operation of resource: server-interface

server-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Delete operation of resource: server-interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/

Retrieve operation of resource: server-interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "profile": "string",    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

SERVER-DHCP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Update operation of resource: server-dhcp-circuit-id

server-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Create operation of resource: server-dhcp-circuit-id

server-dhcp-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Delete operation of resource: server-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SERVER-DHCP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/server-interface/server-dhcp-circuit-id/

Retrieve operation of resource: server-dhcp-circuit-id

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

SNOOP-INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Update operation of resource: snoop-interface

snoop-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "format-type": "integer",
    "circuit-id-value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Create operation of resource: snoop-interface

snoop-interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    "format-type": "integer",
    "circuit-id-value": "string"
  }
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Delete operation of resource: snoop-interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/

Retrieve operation of resource: snoop-interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    "format-type": "integer",
    "circuit-id-value": "string"
  }
}

SNOOP-CIRCUIT-ID - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Update operation of resource: snoop-circuit-id

snoop-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "format-type": "integer",
  "circuit-id-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Create operation of resource: snoop-circuit-id

snoop-circuit-idbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{
  "format-type": "integer",
  "circuit-id-value": "string"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Delete operation of resource: snoop-circuit-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNOOP-CIRCUIT-ID - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/interfaces/interface/{interface-name}/snoop-interface/snoop-circuit-id/

Retrieve operation of resource: snoop-circuit-id

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "format-type": "integer",
  "circuit-id-value": "string"
}

DUPLICATE-MAC-ALLOWED - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Update operation of resource: duplicate-mac-allowed

duplicate-mac-allowedbody object

Request Content-Types: application/json
Request Example
{
  "duplicate-mac": [ null ],
  "exclude-vlan": [ null ],
  "include-giaddr": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Create operation of resource: duplicate-mac-allowed

duplicate-mac-allowedbody object

Request Content-Types: application/json
Request Example
{
  "duplicate-mac": [ null ],
  "exclude-vlan": [ null ],
  "include-giaddr": [ null ]
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Delete operation of resource: duplicate-mac-allowed

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DUPLICATE-MAC-ALLOWED - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/duplicate-mac-allowed/

Retrieve operation of resource: duplicate-mac-allowed

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "duplicate-mac": [ null ],
  "exclude-vlan": [ null ],
  "include-giaddr": [ null ]
}

RATE-LIMIT - Update

PUT Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Update operation of resource: rate-limit

rate-limitbody object

Request Content-Types: application/json
Request Example
{
  "num-period": "integer",
  "num-discover": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Create

POST Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Create operation of resource: rate-limit

rate-limitbody object

Request Content-Types: application/json
Request Example
{
  "num-period": "integer",
  "num-discover": "integer"
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Delete

DELETE Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Delete operation of resource: rate-limit

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RATE-LIMIT - Retrieve

GET Cisco-IOS-XR-ipv4-dhcpd-cfg:ipv4-dhcpd/rate-limit/

Retrieve operation of resource: rate-limit

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "num-period": "integer",
  "num-discover": "integer"
}

Schema Definitions

OPTION-CODE-TABLE:

Common node of server, class

option-codes: object

Table of OptionCode

option-code: object[]

DHCP option code

object
option-code: integer

DHCP option code

range:"0..255"
hex-string: string

Hexadecimal string

ascii-string: string

ASCII string

ip-address: string[]
string

Server's IP address

force-insert: integer

Set constant integer

Example
{
  "option-codes": {
    "option-code": [
      {
        "option-code": "integer",
        "hex-string": "string",
        "ascii-string": "string",
        "ip-address": [ "string" ],
        "force-insert": "integer"
      }
    ]
  }
}

ipv4-dhcpd_schema:

DHCP IPV4 configuration

enable: null

DHCP IPV4 configuration

outer-cos: integer

Configure outer cos values for dhcp packets

range:"0..7"
database: object

Enable DHCP binding database storage to file system

full-write-interval: integer

Full file write interval (default 10 minutes)

range:"1..1440" default:10 minutes)"
incremental-write-interval: integer

Incremental file write interval (default 1 minutes)

range:"1..1440" default:"1"
proxy: null

Enable DHCP proxy binding database storage to file system

snoop: null

Enable DHCP snoop binding database storage to file system

server: null

Enable DHCP server binding database storage to file system

interfaces: object

DHCP IPV4 Interface Table

interface: object[]

DHCP IPV4 Interface

object
profile: object

Profile name and mode

profile-name: string

Profile name

mode: string base, relay, snoop, server, proxy, base2

DHCP mode

interface-name: string

Interface Name

base-interface: object

DHCP IPv4 Base profile information

profile: string

Interface profile name

base-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

proxy-interface: object

DHCP IPv4 proxy information

profile: string

Interface profile name

dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

static-mode: object

Static Table Entries containing MAC address to IP address bindings

statics: object

Static Table Entries containing MAC address to IP address bindings

static: object[]

DHCP static binding of Mac address to IP address

object
client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

server-interface: object

DHCP IPv4 Server information

profile: string

Interface profile name

server-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

relay-interface: object

DHCP IPv4 relay information

relay-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

snoop-interface: object

DHCP IPv4 snoop information

snoop-circuit-id: object

Configure circuit ID for snoop 1. Hex 2. ASCII

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
circuit-id-value: string

Enter circuit-id value

rate-limit: object

Rate limit ingress packets

num-period: integer

Rate limiter period in msec (default: 200 msec)

range:"1..1000" default:"200"
num-discover: integer

Max DISCOVER packets per rate-limiter period (default 100)

range:"0..1000" default:"100"
allow-client-id-change: null

For BNG session, allow client id change for a client MAC

duplicate-mac-allowed: object

Allow Duplicate MAC Address

duplicate-mac: null

Duplicate mac is allowed

exclude-vlan: null

Exclude vlan

include-giaddr: null

Include giaddr

vrfs: object

VRF Table

vrf: object[]

VRF table

object
profile: object

Profile name and mode

mode: string base, relay, snoop, server, proxy, base2

Dhcp mode

vrf-profile-name: string

Profile name

vrf-name: string

VRF Name

inner-cos: integer

Configure inner cos values for dhcp packets

range:"0..7"
profiles: object

DHCP IPV4 Profile Table

profile: object[]

DHCP IPV4 Profile

object
modes: object

DHCP IPV4 Profile modes

mode: object[]

DHCP IPV4 Profile mode

object
proxy: object

DHCP proxy profile

proxy-allow-move: null

Allow dhcp subscriber move

limit-lease: object

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

secure-arp: null

DHCP IPV4 profile proxy secure-arp enable

sessions: object

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
delayed-authen-proxy: null

For BNG session, delay the authentication

auth-username: object

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

giaddr: object

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

lease-proxy: object

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
classes: object

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

relay-information: object

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

enable: null

Enable the DHCP IPV4 Profile mode

relay: object

DHCP Relay profile

gi-addr-policy: object

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

broadcast-policy: object

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

mac-mismatch-action: string forward, drop

Action to take if L2 header source Mac and dhcp header mac address don't match

relay-information-option: object

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

vrfs: object

VRF Helper Addresses

vrf: object[]

VRF Name

object
vrf-name: string

VRF Name

helper-addresses: object

Helper Addresses

helper-address: object[]

Helper Address

object
gateway-address: string

GatewayAddress

enable: null

Enable helper - deprecated

ip-address: string

IPV4 Address

snoop: object

DHCP Snoop profile

relay-information-option: object

DHCP Snoop profile

policy: string replace, keep, drop, encapsulate

Relay information option policy

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

remote-id: object

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

allow-untrusted: null

Forward untrusted packets

trusted: null

Trusted sources

mode: string base, relay, snoop, server, proxy, base2

DHCP IPV4 Profile mode

base: object

DHCP Base Profile

default-profile: object

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

base-relay-opt: object

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

enable: null

Enable the DHCP IPv4 Base Profile

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: integer

Match option 60

option-action: string allow, drop

Vendor action

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop

Vendor action

def-matchoption: integer

Match option 60

base-match: object

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

server:

DHCP Server profile

profile-name: string

Profile Name

Example
{
  "enable": [ null ],
  "outer-cos": "integer",
  "database": {
    "full-write-interval": "integer",
    "incremental-write-interval": "integer",
    "proxy": [ null ],
    "snoop": [ null ],
    "server": [ null ]
  },
  "interfaces": {
    "interface": [
      {
        "profile": {
          "profile-name": "string",
          "mode": "string"
        },
        "interface-name": "string",
        "base-interface": {
          "profile": "string",
          "base-dhcp-circuit-id": {
            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },
        "proxy-interface": {
          "profile": "string",
          "dhcp-circuit-id": {
            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },
        "static-mode": {
          "statics": {
            "static": [
              {
                "client-id": "string",
                "layer": "string",
                "static-address": "string",
                "mac-address": "string"
              }
            ]
          }
        },
        "server-interface": {
          "profile": "string",
          "server-dhcp-circuit-id": {
            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string",
            "argument4": "string",
            "argument5": "string",
            "argument2": "string",
            "argument3": "string",
            "argument1": "string",
            "argument8": "string",
            "argument9": "string"
          }
        },
        "relay-interface": {
          "relay-dhcp-circuit-id": {
            "argument10": "string",
            "argument11": "string",
            "argument12": "string",
            "argument13": "string",
            "argument14": "string",
            "argument15": "string",
            "argument16": "string",
            "format": "string",
            "circuit-id": "string",
            "argument6": "string",
            "argument7": "string"
          }
        }
      }
    ]
  }
}

vrfs_schema:

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

Example
{
  "vrf": [
    {
      "vrf-name": "string",
      "helper-addresses": {
        "helper-address": [
          {
            "server-address": "string",
            "gateway-address": "string"
          }
        ]
      }
    }
  ]
}

vrf_schema:

vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

Example
{
  "vrf-name": "string",
  "helper-addresses": {
    "helper-address": [
      {
        "server-address": "string",
        "gateway-address": "string"
      }
    ]
  }
}

profile_schema:

Profile name and mode

profile-name: string

Profile name

mode: string base, relay, snoop, server, proxy, base2

DHCP mode

Example
{
  "profile-name": "string",
  "mode": "string"
}

profiles_schema:

DHCP IPV4 Profile Table

profile: object[]

DHCP IPV4 Profile

object
modes: object

DHCP IPV4 Profile modes

mode: object[]

DHCP IPV4 Profile mode

object
proxy: object

DHCP proxy profile

proxy-allow-move: null

Allow dhcp subscriber move

limit-lease: object

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

secure-arp: null

DHCP IPV4 profile proxy secure-arp enable

sessions: object

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
delayed-authen-proxy: null

For BNG session, delay the authentication

auth-username: object

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

giaddr: object

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

lease-proxy: object

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
classes: object

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

relay-information: object

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

enable: null

Enable the DHCP IPV4 Profile mode

relay: object

DHCP Relay profile

gi-addr-policy: object

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

broadcast-policy: object

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

mac-mismatch-action: string forward, drop

Action to take if L2 header source Mac and dhcp header mac address don't match

relay-information-option: object

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

vrfs: object

VRF Helper Addresses

vrf: object[]

VRF Name

object
vrf-name: string

VRF Name

helper-addresses: object

Helper Addresses

helper-address: object[]

Helper Address

object
gateway-address: string

GatewayAddress

enable: null

Enable helper - deprecated

ip-address: string

IPV4 Address

snoop: object

DHCP Snoop profile

relay-information-option: object

DHCP Snoop profile

policy: string replace, keep, drop, encapsulate

Relay information option policy

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

remote-id: object

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

allow-untrusted: null

Forward untrusted packets

trusted: null

Trusted sources

mode: string base, relay, snoop, server, proxy, base2

DHCP IPV4 Profile mode

base: object

DHCP Base Profile

default-profile: object

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

base-relay-opt: object

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

enable: null

Enable the DHCP IPv4 Base Profile

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: integer

Match option 60

option-action: string allow, drop

Vendor action

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop

Vendor action

def-matchoption: integer

Match option 60

base-match: object

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

server:

DHCP Server profile

profile-name: string

Profile Name

Example
{
  "profile": [
    {
      "modes": {
        "mode": [
          {
            "proxy": {
              "proxy-allow-move": [ null ],
              "limit-lease": {
                "limit-lease-count": "string",
                "limit-type": "string"
              },
              "secure-arp": [ null ],
              "sessions": {
                "proxy-throttle-type": {
                  "proxy-mac-throttle": {
                    "num-discover": "integer",
                    "num-block": "integer",
                    "num-request": "integer"
                  }
                }
              },
              "delayed-authen-proxy": [ null ],
              "auth-username": {
                "arg1": "string",
                "arg2": "string"
              },
              "giaddr": {
                "policy": "string"
              },
              "lease-proxy": {
                "set-server-options": [ null ],
                "client-lease-time": "integer"
              },
              "classes": {
                "class": [
                  {
                    "enable": [ null ],
                    "vrfs": {
                      "vrf": [
                        {
                          "vrf-name": "string",
                          "helper-addresses": {
                            "helper-address": [
                              {
                                "server-address": "string",
                                "gateway-address": "string"
                              }
                            ]
                          }
                        }
                      ]
                    },
                    "class-name": "string",
                    "match": {
                      "option": {
                        "pattern": "string",
                        "bit-mask": "string",
                        "option-type": "string"
                      },
                      "vrf": "string"
                    }
                  }
                ]
              },
              "vrfs": {
                "vrf": [
                  {
                    "vrf-name": "string",
                    "helper-addresses": {
                      "helper-address": [
                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "enable": [ null ],
              "broadcast-flag": {
                "policy": "string"
              },
              "dhcp-to-aaa": {
                "option": {
                  "list": {
                    "option": [ "integer" ],
                    "option-all": "integer"
                  }
                }
              },
              "match": {
                "option-filters": {
                  "option-filter": [
                    {
                      "pattern": "string",
                      "matchaction": "string",
                      "matchoption": "integer",
                      "format": "integer"
                    }
                  ]
                },
                "def-options": {
                  "def-option": [
                    {
                      "def-matchaction": "string",
                      "def-matchoption": "integer"
                    }
                  ]
                }
              },
              "relay-information": {
                "authenticate": "string",
                "option": [ null ],
                "remote-id-xr": [ null ],
                "allow-untrusted": [ null ],
                "remote-id-suppress": [ null ],
                "vpn-mode": "string",
                "remote-id": "string",
                "circuit-id": [ null ],
                "policy": "string",
                "vpn": [ null ],
                "check": [ null ]
              }
            },
            "enable": [ null ],
            "relay": {
              "gi-addr-policy": {
                "policy": "string"
              },
              "broadcast-policy": {
                "policy": "string"
              },
              "mac-mismatch-action": "string",
              "relay-information-option": {
                "insert": [ null ],
                "subscriber-id": "string"
              }
            }
          }
        ]
      }
    }
  ]
}

modes_schema:

DHCP IPV4 Profile modes

mode: object[]

DHCP IPV4 Profile mode

object
proxy: object

DHCP proxy profile

proxy-allow-move: null

Allow dhcp subscriber move

limit-lease: object

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

secure-arp: null

DHCP IPV4 profile proxy secure-arp enable

sessions: object

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
delayed-authen-proxy: null

For BNG session, delay the authentication

auth-username: object

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

giaddr: object

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

lease-proxy: object

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
classes: object

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

relay-information: object

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

enable: null

Enable the DHCP IPV4 Profile mode

relay: object

DHCP Relay profile

gi-addr-policy: object

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

broadcast-policy: object

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

mac-mismatch-action: string forward, drop

Action to take if L2 header source Mac and dhcp header mac address don't match

relay-information-option: object

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

vrfs: object

VRF Helper Addresses

vrf: object[]

VRF Name

object
vrf-name: string

VRF Name

helper-addresses: object

Helper Addresses

helper-address: object[]

Helper Address

object
gateway-address: string

GatewayAddress

enable: null

Enable helper - deprecated

ip-address: string

IPV4 Address

snoop: object

DHCP Snoop profile

relay-information-option: object

DHCP Snoop profile

policy: string replace, keep, drop, encapsulate

Relay information option policy

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

remote-id: object

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

allow-untrusted: null

Forward untrusted packets

trusted: null

Trusted sources

mode: string base, relay, snoop, server, proxy, base2

DHCP IPV4 Profile mode

base: object

DHCP Base Profile

default-profile: object

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

base-relay-opt: object

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

enable: null

Enable the DHCP IPv4 Base Profile

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: integer

Match option 60

option-action: string allow, drop

Vendor action

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop

Vendor action

def-matchoption: integer

Match option 60

base-match: object

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

server:

DHCP Server profile

Example
{
  "mode": [
    {
      "proxy": {
        "proxy-allow-move": [ null ],
        "limit-lease": {
          "limit-lease-count": "string",
          "limit-type": "string"
        },
        "secure-arp": [ null ],
        "sessions": {
          "proxy-throttle-type": {
            "proxy-mac-throttle": {
              "num-discover": "integer",
              "num-block": "integer",
              "num-request": "integer"
            }
          }
        },
        "delayed-authen-proxy": [ null ],
        "auth-username": {
          "arg1": "string",
          "arg2": "string"
        },
        "giaddr": {
          "policy": "string"
        },
        "lease-proxy": {
          "set-server-options": [ null ],
          "client-lease-time": "integer"
        },
        "classes": {
          "class": [
            {
              "enable": [ null ],
              "vrfs": {
                "vrf": [
                  {
                    "vrf-name": "string",
                    "helper-addresses": {
                      "helper-address": [
                        {
                          "server-address": "string",
                          "gateway-address": "string"
                        }
                      ]
                    }
                  }
                ]
              },
              "class-name": "string",
              "match": {
                "option": {
                  "pattern": "string",
                  "bit-mask": "string",
                  "option-type": "string"
                },
                "vrf": "string"
              }
            }
          ]
        },
        "vrfs": {
          "vrf": [
            {
              "vrf-name": "string",
              "helper-addresses": {
                "helper-address": [
                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "enable": [ null ],
        "broadcast-flag": {
          "policy": "string"
        },
        "dhcp-to-aaa": {
          "option": {
            "list": {
              "option": [ "integer" ],
              "option-all": "integer"
            }
          }
        },
        "match": {
          "option-filters": {
            "option-filter": [
              {
                "pattern": "string",
                "matchaction": "string",
                "matchoption": "integer",
                "format": "integer"
              }
            ]
          },
          "def-options": {
            "def-option": [
              {
                "def-matchaction": "string",
                "def-matchoption": "integer"
              }
            ]
          }
        },
        "relay-information": {
          "authenticate": "string",
          "option": [ null ],
          "remote-id-xr": [ null ],
          "allow-untrusted": [ null ],
          "remote-id-suppress": [ null ],
          "vpn-mode": "string",
          "remote-id": "string",
          "circuit-id": [ null ],
          "policy": "string",
          "vpn": [ null ],
          "check": [ null ]
        }
      },
      "enable": [ null ],
      "relay": {
        "gi-addr-policy": {
          "policy": "string"
        },
        "broadcast-policy": {
          "policy": "string"
        },
        "mac-mismatch-action": "string",
        "relay-information-option": {
          "insert": [ null ],
          "subscriber-id": "string",
          "vpn-mode": "string",
          "allow-untrusted": [ null ],
          "policy": "string"
        }
      }
    }
  ]
}

mode_schema:

proxy: object

DHCP proxy profile

proxy-allow-move: null

Allow dhcp subscriber move

limit-lease: object

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

secure-arp: null

DHCP IPV4 profile proxy secure-arp enable

sessions: object

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
delayed-authen-proxy: null

For BNG session, delay the authentication

auth-username: object

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

giaddr: object

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

lease-proxy: object

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
classes: object

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

relay-information: object

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

enable: null

Enable the DHCP IPV4 Profile mode

relay: object

DHCP Relay profile

gi-addr-policy: object

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

broadcast-policy: object

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

mac-mismatch-action: string forward, drop

Action to take if L2 header source Mac and dhcp header mac address don't match

relay-information-option: object

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

vrfs: object

VRF Helper Addresses

vrf: object[]

VRF Name

object
vrf-name: string

VRF Name

helper-addresses: object

Helper Addresses

helper-address: object[]

Helper Address

object
gateway-address: string

GatewayAddress

enable: null

Enable helper - deprecated

ip-address: string

IPV4 Address

snoop: object

DHCP Snoop profile

relay-information-option: object

DHCP Snoop profile

policy: string replace, keep, drop, encapsulate

Relay information option policy

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

remote-id: object

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

allow-untrusted: null

Forward untrusted packets

trusted: null

Trusted sources

mode: string base, relay, snoop, server, proxy, base2

DHCP IPV4 Profile mode

base: object

DHCP Base Profile

default-profile: object

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

base-relay-opt: object

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

enable: null

Enable the DHCP IPv4 Base Profile

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: integer

Match option 60

option-action: string allow, drop

Vendor action

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop

Vendor action

def-matchoption: integer

Match option 60

base-match: object

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

server:

DHCP Server profile

Example
{
  "proxy": {
    "proxy-allow-move": [ null ],
    "limit-lease": {
      "limit-lease-count": "string",
      "limit-type": "string"
    },
    "secure-arp": [ null ],
    "sessions": {
      "proxy-throttle-type": {
        "proxy-mac-throttle": {
          "num-discover": "integer",
          "num-block": "integer",
          "num-request": "integer"
        }
      }
    },
    "delayed-authen-proxy": [ null ],
    "auth-username": {
      "arg1": "string",
      "arg2": "string"
    },
    "giaddr": {
      "policy": "string"
    },
    "lease-proxy": {
      "set-server-options": [ null ],
      "client-lease-time": "integer"
    },
    "classes": {
      "class": [
        {
          "enable": [ null ],
          "vrfs": {
            "vrf": [
              {
                "vrf-name": "string",
                "helper-addresses": {
                  "helper-address": [
                    {
                      "server-address": "string",
                      "gateway-address": "string"
                    }
                  ]
                }
              }
            ]
          },
          "class-name": "string",
          "match": {
            "option": {
              "pattern": "string",
              "bit-mask": "string",
              "option-type": "string"
            },
            "vrf": "string"
          }
        }
      ]
    },
    "vrfs": {
      "vrf": [
        {
          "vrf-name": "string",
          "helper-addresses": {
            "helper-address": [
              {
                "server-address": "string",
                "gateway-address": "string"
              }
            ]
          }
        }
      ]
    },
    "enable": [ null ],
    "broadcast-flag": {
      "policy": "string"
    },
    "dhcp-to-aaa": {
      "option": {
        "list": {
          "option": [ "integer" ],
          "option-all": "integer"
        }
      }
    },
    "match": {
      "option-filters": {
        "option-filter": [
          {
            "pattern": "string",
            "matchaction": "string",
            "matchoption": "integer",
            "format": "integer"
          }
        ]
      },
      "def-options": {
        "def-option": [
          {
            "def-matchaction": "string",
            "def-matchoption": "integer"
          }
        ]
      }
    },
    "relay-information": {
      "authenticate": "string",
      "option": [ null ],
      "remote-id-xr": [ null ],
      "allow-untrusted": [ null ],
      "remote-id-suppress": [ null ],
      "vpn-mode": "string",
      "remote-id": "string",
      "circuit-id": [ null ],
      "policy": "string",
      "vpn": [ null ],
      "check": [ null ]
    }
  },
  "enable": [ null ],
  "relay": {
    "gi-addr-policy": {
      "policy": "string"
    },
    "broadcast-policy": {
      "policy": "string"
    },
    "mac-mismatch-action": "string",
    "relay-information-option": {
      "insert": [ null ],
      "subscriber-id": "string",
      "vpn-mode": "string",
      "allow-untrusted": [ null ],
      "policy": "string",
      "vpn": [ null ],
      "check": [ null ]
    }
  }
}

snoop_schema:

DHCP Snoop profile

relay-information-option: object

DHCP Snoop profile

policy: string replace, keep, drop, encapsulate

Relay information option policy

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

remote-id: object

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

allow-untrusted: null

Forward untrusted packets

trusted: null

Trusted sources

Example
{
  "relay-information-option": {
    "policy": "string",
    "insert": [ null ],
    "remote-id": {
      "format-type": "integer",
      "remote-id-value": "string"
    },
    "allow-untrusted": [ null ]
  },
  "trusted": [ null ]
}

relay-information-option_schema:

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

Example
{
  "insert": [ null ],
  "subscriber-id": "string",
  "vpn-mode": "string",
  "allow-untrusted": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}

remote-id_schema:

Enter remote-id value

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
remote-id-value: string

Enter remote-id value

Example
{
  "format-type": "integer",
  "remote-id-value": "string"
}

base_schema:

DHCP Base Profile

default-profile: object

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

base-relay-opt: object

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

enable: null

Enable the DHCP IPv4 Base Profile

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: integer

Match option 60

option-action: string allow, drop

Vendor action

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop

Vendor action

def-matchoption: integer

Match option 60

base-match: object

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

Example
{
  "default-profile": {
    "profile-name": "string",
    "profile-mode": "integer"
  },
  "base-relay-opt": {
    "authenticate": "integer",
    "remote-id": "string"
  },
  "enable": [ null ],
  "match": {
    "option-filters": {
      "option-filter": [
        {
          "pattern": "string",
          "matchoption": "integer",
          "option-action": "string",
          "format": "integer"
        }
      ]
    },
    "def-options": {
      "def-option": [
        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },
  "base-match": {
    "options": {
      "option": [
        {
          "opt60": "integer",
          "option-profile": {
            "profile-name": "string",
            "profile-mode": "integer"
          },
          "opt60-hex-str": "string",
          "format": "integer"
        }
      ]
    }
  }
}

default-profile_schema:

Enable the default profile

profile-name: string

Profile name

profile-mode: integer

none

Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}

match_schema:

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

Example
{
  "option-filters": {
    "option-filter": [
      {
        "pattern": "string",
        "matchaction": "string",
        "matchoption": "integer",
        "format": "integer"
      }
    ]
  },
  "def-options": {
    "def-option": [
      {
        "def-matchaction": "string",
        "def-matchoption": "integer"
      }
    ]
  }
}

option-filters_schema:

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

Example
{
  "option-filter": [
    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "integer",
      "format": "integer"
    }
  ]
}

option-filter_schema:

pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

Example
{
  "pattern": "string",
  "matchaction": "string",
  "matchoption": "integer",
  "format": "integer"
}

def-options_schema:

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

Example
{
  "def-option": [
    {
      "def-matchaction": "string",
      "def-matchoption": "integer"
    }
  ]
}

def-option_schema:

def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

Example
{
  "def-matchaction": "string",
  "def-matchoption": "integer"
}

base-relay-opt_schema:

Insert Relay Agent Information circuit ID and remote ID suboptions in client request

authenticate: integer

Specify Relay Agent Information Option authenticate

remote-id: string

Enter remote-id value

Example
{
  "authenticate": "integer",
  "remote-id": "string"
}

base-match_schema:

Insert match keyword

options: object

Specify match option

option: object[]

none

object
opt60: integer

none

option-profile: object

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

opt60-hex-str: string

Enter hex pattern string

format: integer

Set constant integer

Example
{
  "options": {
    "option": [
      {
        "opt60": "integer",
        "option-profile": {
          "profile-name": "string",
          "profile-mode": "integer"
        },
        "opt60-hex-str": "string",
        "format": "integer"
      }
    ]
  }
}

options_schema:

Table of Option

option: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop

Vendor action

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match option 60

format: integer

Set constant integer

Example
{
  "option": [
    {
      "pattern": "string",
      "matchaction": "string",
      "matchoption": "string",
      "format": "integer"
    }
  ]
}

option_schema:

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

Example
{
  "list": {
    "option": [ "integer" ],
    "option-all": "integer"
  }
}

option-profile_schema:

Enter a profile

profile-name: string

Profile name

profile-mode: integer

none

Example
{
  "profile-name": "string",
  "profile-mode": "integer"
}

server_schema:

DHCP Server profile

subnet-mask: string

Configure Subnet Mask

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option-number: integer

Option number

range:"1..255"
option-all: integer

Set constant integer

domain-name: string

Domain name

boot-filename: string

Boot Filename

next-server: string

Configure the tftp-server IP to be used by the client

dns-servers: object

DNS servers

dns-server: string[]
string

DNS Server's IP address

server-id-check: object

Validate server ID check

check: null

specify server-id-check disable

match: object

Insert match keyword

option-defaults: object

Table of OptionDefault

option-default: object[]

Specify match option

object
matchaction: string allow, drop

Vendor action

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match option 60

options: object

Table of Option

option: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop

Vendor action

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match option 60

format: integer

Set constant integer

lease: object

lease

infinite: string

Set string

hours: integer

Hours

range:"0..23" units:"hour"
minutes: integer

Minutes

range:"1..59" units:"minute"
days: integer

Days

range:"0..365" units:"day"
server-allow-move: null

Allow dhcp subscriber move

lease-limit: object

Specify limit lease

range: integer

Value of limit lease count in Decimal

range:"1..240000"
lease-limit-value: string per-interface, per-circuit-id, per-remote-id

Configure Lease limit value

secure-arp: null

Enable Secure Arp

relay: object

Specify Relay Agent Information Option configuration

authenticate: integer

Specify Relay Agent Information Option authenticate

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

None

policy: string ignore, check, unicastalways

Specify broadcast flag policy

net-bios-name-servers: object

NetBIOS name servers

net-bios-name-server: string[]
string

NetBIOSNameServer's IP address

pool: string

Specify the Pool name

session: object

Change sessions configuration

throttle-type: object

Throttle DHCP sessions based on MAC address

mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
default-routers: object

default routers

default-router: string[]
string

Router's IP address

netbios-node-type: object

NetBIOS node type

hybrid-node: string

Set string

mixed-node: string

Set string

hexadecimal: string

Hexadecimal number

broadcast-node: string

Set string

peer-to-peer-node: string

Set string

aaa-server: object

Enable aaa dhcp option force-insert

dhcp-option: object

Enable aaa dhcp option force-insert

force-insert: null

Enable aaa dhcp option force-insert

requested-ip-address: object

Validate Requested IP Address

check: null

specify requested-ip-address-check disable

classes: object

Table of Class

class: object[]

Create or enter server profile class

default-routers: object

default routers

default-router: string[]
string

Router's IP address

class-match: object

Insert match keyword

l2-interface: string

Specify match l2-interface

class-options: object

Table of Class-Option

class-option: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match options

bit-mask: string

Enter bit mask pattern string

vrf: string

Specify match VRF

enable: null

Enable Create or enter server profile class. Deletion of this object also causes deletion of all associated objects under Class.

subnet-mask: string

Configure Subnet Mask

boot-filename: string

Boot Filename

class-name: string

class name

domain-name: string

Domain name

netbios-node-type: object

NetBIOS node type

hybrid-node: string

Set string

mixed-node: string

Set string

hexadecimal: string

Hexadecimal number

broadcast-node: string

Set string

peer-to-peer-node: string

Set string

next-server: string

Configure the tftp-server IP to be used by the client

dns-servers: object

DNS servers

dns-server: string[]
string

DNS Server's IP address

net-bios-name-servers: object

NetBIOS name servers

net-bios-name-server: string[]
string

NetBIOSNameServer's IP address

pool: string

Specify the pool

lease: object

lease

infinite: string

Set string

hours: integer

Hours

range:"0..23" units:"hour"
minutes: integer

Minutes

range:"1..59" units:"minute"
days: integer

Days

range:"0..365" units:"day"
Example
{
  "subnet-mask": "string",
  "dhcp-to-aaa": {
    "option": {
      "list": {
        "option-number": "integer",
        "option-all": "integer"
      }
    }
  },
  "domain-name": "string",
  "boot-filename": "string",
  "next-server": "string",
  "dns-servers": {
    "dns-server": [ "string" ]
  },
  "server-id-check": {
    "check": [ null ]
  },
  "match": {
    "option-defaults": {
      "option-default": [
        {
          "matchaction": "string",
          "matchoption": "string"
        }
      ]
    },
    "options": {
      "option": [
        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "string",
          "format": "integer"
        }
      ]
    }
  },
  "lease": {
    "infinite": "string",
    "hours": "integer",
    "minutes": "integer",
    "days": "integer"
  },
  "server-allow-move": [ null ],
  "lease-limit": {
    "range": "integer",
    "lease-limit-value": "string"
  },
  "secure-arp": [ null ],
  "relay": {
    "authenticate": "integer"
  },
  "enable": [ null ],
  "broadcast-flag": {
    "policy": "string"
  },
  "net-bios-name-servers": {
    "net-bios-name-server": [ "string" ]
  },
  "pool": "string",
  "session": {
    "throttle-type": {
      "mac-throttle": {
        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },
  "default-routers": {
    "default-router": [ "string" ]
  },
  "netbios-node-type": {
    "hybrid-node": "string",
    "mixed-node": "string",
    "hexadecimal": "string",
    "broadcast-node": "string",
    "peer-to-peer-node": "string"
  },
  "aaa-server": {
    "dhcp-option": {
      "force-insert": [ null ]
    }
  },
  "requested-ip-address": {
    "check": [ null ]
  },
  "classes": {
    "class": [
      {
        "default-routers": {
          "default-router": [ "string" ]
        },
        "class-match": {
          "l2-interface": "string",
          "class-options": {}
        },
        "option-codes": {
          "option-code": [
            {
              "option-code": "integer",
              "hex-string": "string",
              "ascii-string": "string",
              "ip-address": [ "string" ],
              "force-insert": "integer"
            }
          ]
        }
      }
    ]
  },
  "option-codes": {
    "option-code": [
      {
        "option-code": "integer",
        "hex-string": "string",
        "ascii-string": "string",
        "ip-address": [ "string" ],
        "force-insert": "integer"
      }
    ]
  }
}

server-id-check_schema:

Validate server ID check

check: null

specify server-id-check disable

Example
{
  "check": [ null ]
}

lease-limit_schema:

Specify limit lease

range: integer

Value of limit lease count in Decimal

range:"1..240000"
lease-limit-value: string per-interface, per-circuit-id, per-remote-id

Configure Lease limit value

Example
{
  "range": "integer",
  "lease-limit-value": "string"
}

requested-ip-address_schema:

Validate Requested IP Address

check: null

specify requested-ip-address-check disable

Example
{
  "check": [ null ]
}

aaa-server_schema:

Enable aaa dhcp option force-insert

dhcp-option: object

Enable aaa dhcp option force-insert

force-insert: null

Enable aaa dhcp option force-insert

Example
{
  "dhcp-option": {
    "force-insert": [ null ]
  }
}

dhcp-option_schema:

Enable aaa dhcp option force-insert

force-insert: null

Enable aaa dhcp option force-insert

Example
{
  "force-insert": [ null ]
}

default-routers_schema:

default routers

default-router: string[]
string

Router's IP address

Example
{
  "default-router": [ "string" ]
}

net-bios-name-servers_schema:

NetBIOS name servers

net-bios-name-server: string[]
string

NetBIOSNameServer's IP address

Example
{
  "net-bios-name-server": [ "string" ]
}

option-defaults_schema:

Table of OptionDefault

option-default: object[]

Specify match option

object
matchaction: string allow, drop

Vendor action

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match option 60

Example
{
  "option-default": [
    {
      "matchaction": "string",
      "matchoption": "string"
    }
  ]
}

option-default_schema:

matchaction: string allow, drop

Vendor action

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match option 60

Example
{
  "matchaction": "string",
  "matchoption": "string"
}

broadcast-flag_schema:

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

Example
{
  "policy": "string"
}

session_schema:

Change sessions configuration

throttle-type: object

Throttle DHCP sessions based on MAC address

mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "throttle-type": {
    "mac-throttle": {
      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}

throttle-type_schema:

Throttle DHCP sessions based on MAC address

mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "mac-throttle": {
    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}

mac-throttle_schema:

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}

classes_schema:

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

Example
{
  "class": [
    {
      "enable": [ null ],
      "vrfs": {
        "vrf": [
          {
            "vrf-name": "string",
            "helper-addresses": {
              "helper-address": [
                {
                  "server-address": "string",
                  "gateway-address": "string"
                }
              ]
            }
          }
        ]
      },
      "class-name": "string",
      "match": {
        "option": {
          "pattern": "string",
          "bit-mask": "string",
          "option-type": "string"
        },
        "vrf": "string"
      }
    }
  ]
}

class_schema:

enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

Example
{
  "enable": [ null ],
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string",
        "helper-addresses": {
          "helper-address": [
            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "class-name": "string",
  "match": {
    "option": {
      "pattern": "string",
      "bit-mask": "string",
      "option-type": "string"
    },
    "vrf": "string"
  }
}

class-match_schema:

Insert match keyword

l2-interface: string

Specify match l2-interface

class-options: object

Table of Class-Option

class-option: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match options

bit-mask: string

Enter bit mask pattern string

vrf: string

Specify match VRF

Example
{
  "l2-interface": "string",
  "class-options": {
    "class-option": [
      {
        "pattern": "string",
        "matchoption": "string",
        "bit-mask": "string"
      }
    ]
  },
  "vrf": "string"
}

class-options_schema:

Table of Class-Option

class-option: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match options

bit-mask: string

Enter bit mask pattern string

Example
{
  "class-option": [
    {
      "pattern": "string",
      "matchoption": "string",
      "bit-mask": "string"
    }
  ]
}

class-option_schema:

pattern: string

Enter hex pattern string

matchoption: string circuitid, remoteid, 60, 77, 124, 125

Match options

bit-mask: string

Enter bit mask pattern string

Example
{
  "pattern": "string",
  "matchoption": "string",
  "bit-mask": "string"
}

lease_schema:

lease

infinite: string

Set string

hours: integer

Hours

range:"0..23" units:"hour"
minutes: integer

Minutes

range:"1..59" units:"minute"
days: integer

Days

range:"0..365" units:"day"
Example
{
  "infinite": "string",
  "hours": "integer",
  "minutes": "integer",
  "days": "integer"
}

netbios-node-type_schema:

NetBIOS node type

hybrid-node: string

Set string

mixed-node: string

Set string

hexadecimal: string

Hexadecimal number

broadcast-node: string

Set string

peer-to-peer-node: string

Set string

Example
{
  "hybrid-node": "string",
  "mixed-node": "string",
  "hexadecimal": "string",
  "broadcast-node": "string",
  "peer-to-peer-node": "string"
}

dns-servers_schema:

DNS servers

dns-server: string[]
string

DNS Server's IP address

Example
{
  "dns-server": [ "string" ]
}

option-codes_schema:

Table of OptionCode

option-code: object[]

DHCP option code

object
option-code: integer

DHCP option code

range:"0..255"
hex-string: string

Hexadecimal string

ascii-string: string

ASCII string

ip-address: string[]
string

Server's IP address

force-insert: integer

Set constant integer

Example
{
  "option-code": [
    {
      "option-code": "integer",
      "hex-string": "string",
      "ascii-string": "string",
      "ip-address": [ "string" ],
      "force-insert": "integer"
    }
  ]
}

option-code_schema:

option-code: integer

DHCP option code

range:"0..255"
hex-string: string

Hexadecimal string

ascii-string: string

ASCII string

ip-address: string[]
string

Server's IP address

force-insert: integer

Set constant integer

Example
{
  "option-code": "integer",
  "hex-string": "string",
  "ascii-string": "string",
  "ip-address": [ "string" ],
  "force-insert": "integer"
}

relay_schema:

DHCP Relay profile

gi-addr-policy: object

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

broadcast-policy: object

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

mac-mismatch-action: string forward, drop

Action to take if L2 header source Mac and dhcp header mac address don't match

relay-information-option: object

Relay agent information option

insert: null

Insert Relay Agent Information circuit ID and remote ID suboptions in client requests

subscriber-id: string

Subscriber ID

vpn-mode: string rfc, cisco

VPN Mode

allow-untrusted: null

Forward untrusted packets

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check Relay Agent Information Option in server reply

vrfs: object

VRF Helper Addresses

vrf: object[]

VRF Name

object
vrf-name: string

VRF Name

helper-addresses: object

Helper Addresses

helper-address: object[]

Helper Address

object
gateway-address: string

GatewayAddress

enable: null

Enable helper - deprecated

ip-address: string

IPV4 Address

Example
{
  "gi-addr-policy": {
    "policy": "string"
  },
  "broadcast-policy": {
    "policy": "string"
  },
  "mac-mismatch-action": "string",
  "relay-information-option": {
    "insert": [ null ],
    "subscriber-id": "string",
    "vpn-mode": "string",
    "allow-untrusted": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  },
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string",
        "helper-addresses": {
          "helper-address": [
            {
              "gateway-address": "string",
              "enable": [ null ],
              "ip-address": "string"
            }
          ]
        }
      }
    ]
  }
}

dhcp-to-aaa_schema:

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

Example
{
  "option": {
    "list": {
      "option": [ "integer" ],
      "option-all": "integer"
    }
  }
}

list_schema:

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

Example
{
  "option": [ "integer" ],
  "option-all": "integer"
}

gi-addr-policy_schema:

GIADDR policy

policy: string giaddr-policy-keep

GIADDR policy

Example
{
  "policy": "string"
}

helper-addresses_schema:

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

Example
{
  "helper-address": [
    {
      "server-address": "string",
      "gateway-address": "string"
    }
  ]
}

helper-address_schema:

server-address: string

IPv4 address

gateway-address: string

Gateway address

Example
{
  "server-address": "string",
  "gateway-address": "string"
}

broadcast-policy_schema:

Broadcast Flag policy

policy: string ignore, check, unicast-always

Broadcast flag policy

Example
{
  "policy": "string"
}

proxy_schema:

DHCP proxy profile

proxy-allow-move: null

Allow dhcp subscriber move

limit-lease: object

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

secure-arp: null

DHCP IPV4 profile proxy secure-arp enable

sessions: object

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
delayed-authen-proxy: null

For BNG session, delay the authentication

auth-username: object

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

giaddr: object

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

lease-proxy: object

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
classes: object

DHCP class table

class: object[]

DHCP class

object
enable: null

Enable the DHCP IPV4 proxy class

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

class-name: string

Class name

match: object

Match option

option: object

Match option

pattern: string

Hex pattern string

bit-mask: string

Bit mask pattern

option-type: string 60/60, 77/77, 124/124, 125/125

Match option

vrf: string

Match VRF name

vrfs: object

List of VRFs

vrf: object[]

VRF name

object
vrf-name: string

VRF name

helper-addresses: object

Helper addresses

helper-address: object[]

Helper address

object
server-address: string

IPv4 address

gateway-address: string

Gateway address

enable: null

DHCP IPV4 profile mode enable

broadcast-flag: object

Specify broadcast flag

policy: string ignore, check, unicast-always

Broadcast flag policy

dhcp-to-aaa: object

Enable to provide the list of options need to send to aaa

option: object

option type

list: object

List of options

option: integer[]
integer

List of options

range:"1..255"
option-all: integer

option all

match: object

Insert match keyword

option-filters: object

Table of Option

option-filter: object[]

Specify match option

object
pattern: string

Enter hex pattern string

matchaction: string allow, drop, relay

Vendor action

matchoption: integer

Match option 60

format: integer

Set constant integer

def-options: object

Table of Option

def-option: object[]

Specify match option

object
def-matchaction: string allow, drop, relay

Vendor action

def-matchoption: integer

Match option 60

relay-information: object

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

Example
{
  "proxy-allow-move": [ null ],
  "limit-lease": {
    "limit-lease-count": "string",
    "limit-type": "string"
  },
  "secure-arp": [ null ],
  "sessions": {
    "proxy-throttle-type": {
      "proxy-mac-throttle": {
        "num-discover": "integer",
        "num-block": "integer",
        "num-request": "integer"
      }
    }
  },
  "delayed-authen-proxy": [ null ],
  "auth-username": {
    "arg1": "string",
    "arg2": "string"
  },
  "giaddr": {
    "policy": "string"
  },
  "lease-proxy": {
    "set-server-options": [ null ],
    "client-lease-time": "integer"
  },
  "classes": {
    "class": [
      {
        "enable": [ null ],
        "vrfs": {
          "vrf": [
            {
              "vrf-name": "string",
              "helper-addresses": {
                "helper-address": [
                  {
                    "server-address": "string",
                    "gateway-address": "string"
                  }
                ]
              }
            }
          ]
        },
        "class-name": "string",
        "match": {
          "option": {
            "pattern": "string",
            "bit-mask": "string",
            "option-type": "string"
          },
          "vrf": "string"
        }
      }
    ]
  },
  "vrfs": {
    "vrf": [
      {
        "vrf-name": "string",
        "helper-addresses": {
          "helper-address": [
            {
              "server-address": "string",
              "gateway-address": "string"
            }
          ]
        }
      }
    ]
  },
  "enable": [ null ],
  "broadcast-flag": {
    "policy": "string"
  },
  "dhcp-to-aaa": {
    "option": {
      "list": {
        "option": [ "integer" ],
        "option-all": "integer"
      }
    }
  },
  "match": {
    "option-filters": {
      "option-filter": [
        {
          "pattern": "string",
          "matchaction": "string",
          "matchoption": "integer",
          "format": "integer"
        }
      ]
    },
    "def-options": {
      "def-option": [
        {
          "def-matchaction": "string",
          "def-matchoption": "integer"
        }
      ]
    }
  },
  "relay-information": {
    "authenticate": "string",
    "option": [ null ],
    "remote-id-xr": [ null ],
    "allow-untrusted": [ null ],
    "remote-id-suppress": [ null ],
    "vpn-mode": "string",
    "remote-id": "string",
    "circuit-id": [ null ],
    "policy": "string",
    "vpn": [ null ],
    "check": [ null ]
  }
}

giaddr_schema:

Specify gateway address policy

policy: string giaddr-policy-keep

Gateway address policy

Example
{
  "policy": "string"
}

auth-username_schema:

Authentication Username formating

arg1: string auth-username-mac, auth-username-giaddr

Username Formatting first argument

arg2: string auth-username-mac, auth-username-giaddr

Username Formatting second argument

Example
{
  "arg1": "string",
  "arg2": "string"
}

relay-information_schema:

Relay agent information option

authenticate: string received, inserted

Relay information option authenticate

option: null

Insert relay rgent information circuit ID and remote ID suboptions in client requests

remote-id-xr: null

Insert Remote-id sub-option

allow-untrusted: null

Forward untrusted packets

remote-id-suppress: null

Suppress Remote ID

vpn-mode: string rfc, cisco

VPN Mode

remote-id: string

Remote ID

circuit-id: null

Insert Circuit-id sub-option

policy: string replace, keep, drop, encapsulate

Relay information option policy

vpn: null

Insert VPN options

check: null

Check relay agent information option in server reply

Example
{
  "authenticate": "string",
  "option": [ null ],
  "remote-id-xr": [ null ],
  "allow-untrusted": [ null ],
  "remote-id-suppress": [ null ],
  "vpn-mode": "string",
  "remote-id": "string",
  "circuit-id": [ null ],
  "policy": "string",
  "vpn": [ null ],
  "check": [ null ]
}

sessions_schema:

Change sessions configuration

proxy-throttle-type: object

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "proxy-throttle-type": {
    "proxy-mac-throttle": {
      "num-discover": "integer",
      "num-block": "integer",
      "num-request": "integer"
    }
  }
}

proxy-throttle-type_schema:

Throttle DHCP sessions based on MAC address

proxy-mac-throttle: object

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "proxy-mac-throttle": {
    "num-discover": "integer",
    "num-block": "integer",
    "num-request": "integer"
  }
}

proxy-mac-throttle_schema:

Throttle DHCP sessions from any one MAC address

num-discover: integer

Number of discovers at which to throttle

range:"0..1000" default:"100"
num-block: integer

Throttle blocking period (in secs)

range:"1..100" units:"second"
num-request: integer

Throttle request period (in secs)

range:"1..100" units:"second"
Example
{
  "num-discover": "integer",
  "num-block": "integer",
  "num-request": "integer"
}

limit-lease_schema:

Proxy limit lease

limit-lease-count: string

Limit lease count

limit-type: string interface, circuit-id, remote-id, circuit-id-remote-id

Lease limit type

Example
{
  "limit-lease-count": "string",
  "limit-type": "string"
}

lease-proxy_schema:

DHCPv4 lease proxy

set-server-options: null

Set DHCP server sent options in lease proxy generating ACK

client-lease-time: integer

Specify client lease proxy time

range:"300..4294967295"
Example
{
  "set-server-options": [ null ],
  "client-lease-time": "integer"
}

database_schema:

Enable DHCP binding database storage to file system

full-write-interval: integer

Full file write interval (default 10 minutes)

range:"1..1440" default:10 minutes)"
incremental-write-interval: integer

Incremental file write interval (default 1 minutes)

range:"1..1440" default:"1"
proxy: null

Enable DHCP proxy binding database storage to file system

snoop: null

Enable DHCP snoop binding database storage to file system

server: null

Enable DHCP server binding database storage to file system

Example
{
  "full-write-interval": "integer",
  "incremental-write-interval": "integer",
  "proxy": [ null ],
  "snoop": [ null ],
  "server": [ null ]
}

interfaces_schema:

DHCP IPV4 Interface Table

interface: object[]

DHCP IPV4 Interface

object
profile: object

Profile name and mode

profile-name: string

Profile name

mode: string base, relay, snoop, server, proxy, base2

DHCP mode

interface-name: string

Interface Name

base-interface: object

DHCP IPv4 Base profile information

profile: string

Interface profile name

base-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

proxy-interface: object

DHCP IPv4 proxy information

profile: string

Interface profile name

dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

static-mode: object

Static Table Entries containing MAC address to IP address bindings

statics: object

Static Table Entries containing MAC address to IP address bindings

static: object[]

DHCP static binding of Mac address to IP address

object
client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

server-interface: object

DHCP IPv4 Server information

profile: string

Interface profile name

server-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

relay-interface: object

DHCP IPv4 relay information

relay-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

snoop-interface: object

DHCP IPv4 snoop information

snoop-circuit-id: object

Configure circuit ID for snoop 1. Hex 2. ASCII

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
circuit-id-value: string

Enter circuit-id value

Example
{
  "interface": [
    {
      "profile": {
        "profile-name": "string",
        "mode": "string"
      },
      "interface-name": "string",
      "base-interface": {
        "profile": "string",
        "base-dhcp-circuit-id": {
          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },
      "proxy-interface": {
        "profile": "string",
        "dhcp-circuit-id": {
          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },
      "static-mode": {
        "statics": {
          "static": [
            {
              "client-id": "string",
              "layer": "string",
              "static-address": "string",
              "mac-address": "string"
            }
          ]
        }
      },
      "server-interface": {
        "profile": "string",
        "server-dhcp-circuit-id": {
          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },
      "relay-interface": {
        "relay-dhcp-circuit-id": {
          "argument10": "string",
          "argument11": "string",
          "argument12": "string",
          "argument13": "string",
          "argument14": "string",
          "argument15": "string",
          "argument16": "string",
          "format": "string",
          "circuit-id": "string",
          "argument6": "string",
          "argument7": "string",
          "argument4": "string",
          "argument5": "string",
          "argument2": "string",
          "argument3": "string",
          "argument1": "string",
          "argument8": "string",
          "argument9": "string"
        }
      },
      "snoop-interface": {
        "snoop-circuit-id": {}
      }
    }
  ]
}

interface_schema:

profile: object

Profile name and mode

profile-name: string

Profile name

mode: string base, relay, snoop, server, proxy, base2

DHCP mode

interface-name: string

Interface Name

base-interface: object

DHCP IPv4 Base profile information

profile: string

Interface profile name

base-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

proxy-interface: object

DHCP IPv4 proxy information

profile: string

Interface profile name

dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

static-mode: object

Static Table Entries containing MAC address to IP address bindings

statics: object

Static Table Entries containing MAC address to IP address bindings

static: object[]

DHCP static binding of Mac address to IP address

object
client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

server-interface: object

DHCP IPv4 Server information

profile: string

Interface profile name

server-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

relay-interface: object

DHCP IPv4 relay information

relay-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

snoop-interface: object

DHCP IPv4 snoop information

snoop-circuit-id: object

Configure circuit ID for snoop 1. Hex 2. ASCII

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
circuit-id-value: string

Enter circuit-id value

Example
{
  "profile": {
    "profile-name": "string",
    "mode": "string"
  },
  "interface-name": "string",
  "base-interface": {
    "profile": "string",
    "base-dhcp-circuit-id": {
      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },
  "proxy-interface": {
    "profile": "string",
    "dhcp-circuit-id": {
      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },
  "static-mode": {
    "statics": {
      "static": [
        {
          "client-id": "string",
          "layer": "string",
          "static-address": "string",
          "mac-address": "string"
        }
      ]
    }
  },
  "server-interface": {
    "profile": "string",
    "server-dhcp-circuit-id": {
      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },
  "relay-interface": {
    "relay-dhcp-circuit-id": {
      "argument10": "string",
      "argument11": "string",
      "argument12": "string",
      "argument13": "string",
      "argument14": "string",
      "argument15": "string",
      "argument16": "string",
      "format": "string",
      "circuit-id": "string",
      "argument6": "string",
      "argument7": "string",
      "argument4": "string",
      "argument5": "string",
      "argument2": "string",
      "argument3": "string",
      "argument1": "string",
      "argument8": "string",
      "argument9": "string"
    }
  },
  "snoop-interface": {
    "snoop-circuit-id": {
      "format-type": "integer",
      "circuit-id-value": "string"
    }
  }
}

proxy-interface_schema:

DHCP IPv4 proxy information

profile: string

Interface profile name

dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "profile": "string",
  "dhcp-circuit-id": {
    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

dhcp-circuit-id_schema:

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

base-interface_schema:

DHCP IPv4 Base profile information

profile: string

Interface profile name

base-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "profile": "string",
  "base-dhcp-circuit-id": {
    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

base-dhcp-circuit-id_schema:

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

relay-interface_schema:

DHCP IPv4 relay information

relay-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "relay-dhcp-circuit-id": {
    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

relay-dhcp-circuit-id_schema:

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

static-mode_schema:

Static Table Entries containing MAC address to IP address bindings

statics: object

Static Table Entries containing MAC address to IP address bindings

static: object[]

DHCP static binding of Mac address to IP address

object
client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

Example
{
  "statics": {
    "static": [
      {
        "client-id": "string",
        "layer": "string",
        "static-address": "string",
        "mac-address": "string"
      }
    ]
  }
}

statics_schema:

Static Table Entries containing MAC address to IP address bindings

static: object[]

DHCP static binding of Mac address to IP address

object
client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

Example
{
  "static": [
    {
      "client-id": "string",
      "layer": "string",
      "static-address": "string",
      "mac-address": "string"
    }
  ]
}

static_schema:

client-id: string

Client Id

layer: string layer2, layer3

DHCP IPV4 Static layer

static-address: string

IP address

mac-address: string

MACAddress

Example
{
  "client-id": "string",
  "layer": "string",
  "static-address": "string",
  "mac-address": "string"
}

server-interface_schema:

DHCP IPv4 Server information

profile: string

Interface profile name

server-dhcp-circuit-id: object

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "profile": "string",
  "server-dhcp-circuit-id": {
    "argument10": "string",
    "argument11": "string",
    "argument12": "string",
    "argument13": "string",
    "argument14": "string",
    "argument15": "string",
    "argument16": "string",
    "format": "string",
    "circuit-id": "string",
    "argument6": "string",
    "argument7": "string",
    "argument4": "string",
    "argument5": "string",
    "argument2": "string",
    "argument3": "string",
    "argument1": "string",
    "argument8": "string",
    "argument9": "string"
  }
}

server-dhcp-circuit-id_schema:

Circuit ID value

argument10: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument11: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument12: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument13: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument14: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument15: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument16: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

format: string no-format, format

Format String

circuit-id: string

DHCP IPv4 circuit ID value

argument6: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument7: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument4: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument5: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument2: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument3: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument1: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument8: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

argument9: string physical-chassis, physical-slot, physical-sub-slot, physical-port, physical-sub-port, inner-vlan-id, outer-vlan-id, l2-interface

Argument

Example
{
  "argument10": "string",
  "argument11": "string",
  "argument12": "string",
  "argument13": "string",
  "argument14": "string",
  "argument15": "string",
  "argument16": "string",
  "format": "string",
  "circuit-id": "string",
  "argument6": "string",
  "argument7": "string",
  "argument4": "string",
  "argument5": "string",
  "argument2": "string",
  "argument3": "string",
  "argument1": "string",
  "argument8": "string",
  "argument9": "string"
}

snoop-interface_schema:

DHCP IPv4 snoop information

snoop-circuit-id: object

Configure circuit ID for snoop 1. Hex 2. ASCII

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
circuit-id-value: string

Enter circuit-id value

Example
{
  "snoop-circuit-id": {
    "format-type": "integer",
    "circuit-id-value": "string"
  }
}

snoop-circuit-id_schema:

Configure circuit ID for snoop 1. Hex 2. ASCII

format-type: integer

Format type, 1. Hex 2. ASCII

range:"1..2"
circuit-id-value: string

Enter circuit-id value

Example
{
  "format-type": "integer",
  "circuit-id-value": "string"
}

duplicate-mac-allowed_schema:

Allow Duplicate MAC Address

duplicate-mac: null

Duplicate mac is allowed

exclude-vlan: null

Exclude vlan

include-giaddr: null

Include giaddr

Example
{
  "duplicate-mac": [ null ],
  "exclude-vlan": [ null ],
  "include-giaddr": [ null ]
}

rate-limit_schema:

Rate limit ingress packets

num-period: integer

Rate limiter period in msec (default: 200 msec)

range:"1..1000" default:"200"
num-discover: integer

Max DISCOVER packets per rate-limiter period (default 100)

range:"0..1000" default:"100"
Example
{
  "num-period": "integer",
  "num-discover": "integer"
}